> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zivio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a Milestone



## OpenAPI

````yaml /api-reference/v4/openapi.json get /milestones/{id}
openapi: 3.1.0
info:
  title: API V4
  version: '4'
  description: >-
    OAuth 2.0 secured API. Obtain an access token using client credentials to
    access protected endpoints. The regional endpoints listed below serve every
    Zivio organisation, so each request — including the token request — must
    carry a `zivio-tenant-id` header identifying yours. Requests without it are
    rejected with a 404 before any token is checked.
  contact:
    name: API Support
    email: support@zivio.com
servers:
  - url: https://api.zivio.net/api/v4
    description: Global API Router
  - url: https://api.eu.zivio.net/api/v4
    description: EU Data Region
  - url: https://api.uk.zivio.net/api/v4
    description: UK Data Region
  - url: https://api.us.zivio.net/api/v4
    description: US Data Region
security:
  - oauth2: []
    tenantId: []
paths:
  /milestones/{id}:
    get:
      tags:
        - Milestones
      summary: Get a Milestone
      operationId: getMilestonesById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: Milestone ID
          example: 123
      responses:
        '200':
          description: Milestone details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Milestone'
              example:
                id: 101
                title: Website Redesign Project
                status: submitted
                client_suggested: false
                close_project: false
                comments: Additional information and context for this record.
                details: Additional information and context for this record.
                due_on: '2024-01-16'
                project_summary: >-
                  Website Redesign Project - Complete redesign of corporate
                  website with modern UX
                mandatory: false
                notes: Additional information and context for this record.
                original_id: 501
                original_rate:
                  cents: 150000
                  currency: GBP
                purchase_order_line_id: 501
                rate:
                  cents: 150000
                  currency: GBP
                submitted_at: '2024-01-16T10:30:00+00:00'
                interim_valuation_date: '2024-01-16T10:30:00+00:00'
                tiered_markup_fee:
                  cents: 150000
                  currency: GBP
                children:
                  - 201
                  - 202
                parents:
                  - 201
                  - 202
                custom_fields:
                  department: Engineering
                  priority: high
                  cost_code: CC-001
                created_at: '2024-01-16T10:30:00+00:00'
                updated_at: '2024-01-16T10:30:00+00:00'
                project_id: 501
                final_claim: 'false'
                delivered_on: '2024-01-16'
                approved_by:
                  id: 101
                  first_name: Demo
                  last_name: User
                  email: user1@example.com
                  org_id: 501
                  org_name: Acme Corporation
                rejected_by:
                  id: 101
                  first_name: Demo
                  last_name: User
                  email: user1@example.com
                  org_id: 501
                  org_name: Acme Corporation
                level_1_approved_by:
                  id: 101
                  first_name: Demo
                  last_name: User
                  email: user1@example.com
                  org_id: 501
                  org_name: Acme Corporation
        '401':
          description: >-
            Unauthorized - the access token is missing, expired, revoked or
            malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_token
                error_description: >-
                  The access token provided is expired, revoked, malformed, or
                  invalid for other reasons
        '403':
          description: Forbidden - insufficient scope or access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                insufficient_scope:
                  summary: Token lacks required scope
                  value:
                    error: insufficient_scope
                    error_description: >-
                      The request requires higher privileges than provided by
                      the access token
                    required_scope: milestones:read
                    provided_scopes:
                      - welcome:read
                access_denied:
                  summary: User cannot access this resource
                  value:
                    message: You do not have permission to access this resource
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Record not found
      security:
        - oauth2:
            - milestones:read
          tenantId: []
components:
  schemas:
    Milestone:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string
        status:
          type: string
          enum:
            - open
            - submitted
            - approved
            - rejected
            - change_requested
            - on_hold
            - draft
            - cancelled
            - level_1_approved
            - closed
          example: open
        client_suggested:
          type: boolean
          example: true
        close_project:
          type: boolean
          example: true
        comments:
          type: string
        details:
          type: string
        due_on:
          type: string
        project_summary:
          type: string
        mandatory:
          type: boolean
          example: true
        notes:
          type: string
        original_id:
          type: integer
        original_rate:
          $ref: '#/components/schemas/Money'
        purchase_order_line_id:
          type: integer
        rate:
          $ref: '#/components/schemas/Money'
        submitted_at:
          type: string
        interim_valuation_date:
          type: string
        tiered_markup_fee:
          $ref: '#/components/schemas/Money'
        children:
          type: array
          items:
            type: integer
          description: Array of IDs
        parents:
          type: array
          items:
            type: integer
          description: Array of IDs
        custom_fields:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of custom field data
        created_at:
          type: string
        updated_at:
          type: string
        project_id:
          type: integer
        final_claim:
          type: boolean
          example: true
        delivered_on:
          type: string
        approved_by:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
        rejected_by:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
        level_1_approved_by:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
    Error:
      type: object
      description: Error envelope returned by every non-2xx V4 response
      properties:
        error:
          type: string
          example: insufficient_scope
        error_description:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
        required_scope:
          type: string
          example: projects:read
        provided_scopes:
          type: array
          items:
            type: string
    Money:
      type: object
      properties:
        cents:
          type: integer
          example: 150000
        currency:
          type: string
          example: GBP
    EmbeddedUser:
      type: object
      properties:
        id:
          type: integer
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        org_id:
          type: integer
        org_name:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 client credentials. The access token from POST /oauth/token is
        sent as a bearer token. Request only the scopes you need.
      flows:
        clientCredentials:
          tokenUrl: https://api.zivio.net/api/v4/oauth/token
          scopes:
            bank_accounts:read: Read bank account details on suppliers and the org.
            catalogs:read: Read catalog items.
            cost_centers:read: Read cost center records.
            eoi_responses:read: Read responses to expressions of interest.
            eois:read: Read expressions of interest.
            offers:read: Read offers for projects.
            org_units:read: Read your organization unit hierarchy.
            org_users:read: Read members of your organization.
            resources:read: Read resource (worker) records.
            sales_invoices:read: Read invoices issued to clients.
            sales_milestones:read: Read milestones on sales engagements.
            skill_categories:read: Read the skill category taxonomy.
            skill_taxonomies:read: Read skill taxonomy structure.
            skills:read: Read individual skills.
            supplier_documents:read: Read documents uploaded by suppliers.
            supplier_lists:read: Read curated lists of suppliers.
            supplier_users:read: Read users belonging to supplier organizations.
            tax_types:read: Read configured tax types.
            users:read: Read user profiles.
            variation_orders:read: Read variation orders on projects.
            welcome:read: 'Required: confirms your identity to the application.'
            bid_evaluations:read: >-
              Read evaluation scorecards for bids, including criterion scores
              and quality, cost and total scores.
            bid_evaluations:write: >-
              Score bids against a project's quality criteria and override
              calculated cost scores.
            bids:read: Read bids submitted on projects.
            bids:write: >-
              Shortlist, select, eliminate and reinstate bids submitted on
              projects.
            invoices:read: Read invoices on projects.
            invoices:write: Create and update invoices.
            notes:read: Read notes on projects and EOIs.
            notes:write: Create and update notes on projects and EOIs.
            project_approvals:read: Read project approval workflows.
            project_approvals:write: Create and update project approval workflows.
            project_conversations:read: Read messages exchanged with suppliers on a project.
            project_conversations:write: Send messages to suppliers on a project.
            project_invitations:read: Read supplier invitations on projects.
            project_invitations:write: Invite suppliers to bid on projects.
            project_questions:read: Read supplier clarification questions on projects.
            project_questions:write: Answer and approve supplier clarification questions.
            projects:read: Read projects.
            projects:write: Create and update projects.
            milestones:read: Read milestones on projects.
            milestones:write: Create and update milestones.
            orgs:read: Read organization records.
            orgs:write: Create and update organization records.
            purchase_orders:read: Read purchase orders.
            purchase_orders:write: Create and update purchase orders.
            reviews:read: Read reviews left on suppliers.
            reviews:write: Create and update reviews.
            suppliers:read: Read supplier profiles.
            suppliers:write: Create and update supplier profiles.
            raw_scorecard_entries:write: Create and update raw scorecard entries.
            raw_scorecard_entries:read: Read raw scorecard entries.
            tasks:read: >-
              Read the acting user's task queue, including outstanding approvals
              and items to review.
            tasks:write: Complete and dismiss tasks in the acting user's task queue.
            act_as_user: >-
              Make requests as another user within the token holder's delegation
              boundary.
    tenantId:
      type: apiKey
      name: zivio-tenant-id
      in: header
      description: >-
        Your Zivio organisation identifier. The regional API endpoints serve
        every Zivio organisation, so each request must identify yours.

````