> ## 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 Bid



## OpenAPI

````yaml /api-reference/v4/openapi.json get /bids/{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:
  /bids/{id}:
    get:
      tags:
        - Bids
      summary: Get a Bid
      operationId: getBidsById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: Bid ID
          example: 123
      responses:
        '200':
          description: Bid details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bid'
              example:
                id: 101
                rate:
                  cents: 150000
                  currency: GBP
                fee: '1500.00'
                proposal: Example proposal
                supplier:
                  id: 101
                  name: Acme Corporation
                  email: user1@example.com
                  vetting_status: PASSED
                  tax_number: Example tax_number
                  tax_registered: true
                user:
                  id: 101
                  first_name: Demo
                  last_name: User
                  email: user1@example.com
                  org_id: 501
                  org_name: Acme Corporation
                version: 101
                status: submitted
                managed_bid: true
                bafo: true
                submitted_at: '2024-01-16T10:30:00+00:00'
                read_at: '2024-01-16T10:30:00+00:00'
                shortlisted_at: '2024-01-16T10:30:00+00:00'
                selected_at: '2024-01-16T10:30:00+00:00'
                hours: 101
                eliminated: true
                hired: true
                total_score: '1500.00'
                quality_score: '1500.00'
                cost_score_auto: '1500.00'
                cost_score_override: '1500.00'
                source: Example source
                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: 101
                  title: Website Redesign Project
                  description: Complete redesign of corporate website with modern UX
                bid_milestones:
                  - id: 101
                    bid_id: 501
                    title: Website Redesign Project
                    details: Additional information and context for this record.
                    rate:
                      cents: 150000
                      currency: GBP
                    due_on: '2024-01-16'
                    mandatory: false
                    client_suggested: false
                    created_at: '2024-01-16T10:30:00+00:00'
                    updated_at: '2024-01-16T10:30:00+00:00'
                  - id: 102
                    bid_id: 502
                    title: Mobile App Development
                    details: Additional information and context for this record.
                    rate:
                      cents: 300000
                      currency: GBP
                    due_on: '2024-01-17'
                    mandatory: false
                    client_suggested: false
                    created_at: '2024-01-17T10:30:00+00:00'
                    updated_at: '2024-01-17T10:30:00+00:00'
                line_item_proposals:
                  - id: 101
                    item_type: service
                    name: Acme Corporation
                    manufacturer_name: Example manufacturer_name
                    manufacturer_part_number: Example manufacturer_part_number
                    quantity: '1500.00'
                    price:
                      cents: 150000
                      currency: GBP
                    uom:
                      id: 101
                      name: Acme Corporation
                      code: Example code
                      active: true
                    net_total_price: null
                    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_line_item:
                      id: 101
                      name: Acme Corporation
                      manufacturer_name: Example manufacturer_name
                      manufacturer_part_number: Example manufacturer_part_number
                      uom: null
                      item: null
                      item_type: service
                      price:
                        cents: 150000
                        currency: GBP
                      quantity: '1500.00'
                      net_total_price: null
                      quantity_delivered: null
                      quantity_undelivered: null
                      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
                  - id: 102
                    item_type: item
                    name: Global Services Ltd
                    manufacturer_name: Example manufacturer_name
                    manufacturer_part_number: Example manufacturer_part_number
                    quantity: '1500.00'
                    price:
                      cents: 300000
                      currency: GBP
                    uom:
                      id: 102
                      name: Global Services Ltd
                      code: Example code
                      active: true
                    net_total_price: null
                    custom_fields:
                      department: Engineering
                      priority: high
                      cost_code: CC-001
                    created_at: '2024-01-17T10:30:00+00:00'
                    updated_at: '2024-01-17T10:30:00+00:00'
                    project_line_item:
                      id: 102
                      name: Global Services Ltd
                      manufacturer_name: Example manufacturer_name
                      manufacturer_part_number: Example manufacturer_part_number
                      uom: null
                      item: null
                      item_type: item
                      price:
                        cents: 300000
                        currency: GBP
                      quantity: '1500.00'
                      net_total_price: null
                      quantity_delivered: null
                      quantity_undelivered: null
                      custom_fields:
                        department: Engineering
                        priority: high
                        cost_code: CC-001
                      created_at: '2024-01-17T10:30:00+00:00'
                      updated_at: '2024-01-17T10:30:00+00:00'
                      project_id: 502
        '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: bids: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:
            - bids:read
          tenantId: []
components:
  schemas:
    Bid:
      type: object
      properties:
        id:
          type: integer
        rate:
          $ref: '#/components/schemas/Money'
        fee:
          type: string
        proposal:
          type: string
        supplier:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedSupplier'
            - type: 'null'
        user:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
        version:
          type: integer
        status:
          type: string
          enum:
            - draft
            - submitted
            - superseded
            - withdrawn
          example: draft
        managed_bid:
          type: boolean
          example: true
        bafo:
          type: boolean
          example: true
        submitted_at:
          type: string
        read_at:
          type: string
        shortlisted_at:
          type: string
        selected_at:
          type: string
        hours:
          type: integer
        eliminated:
          type: boolean
          example: true
        hired:
          type: boolean
          example: true
        total_score:
          type: string
        quality_score:
          type: string
        cost_score_auto:
          type: string
        cost_score_override:
          type: string
        source:
          type: string
        custom_fields:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of custom field data
        created_at:
          type: string
        updated_at:
          type: string
        project:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedProject'
            - type: 'null'
        bid_milestones:
          type: array
          items:
            $ref: '#/components/schemas/BidMilestone'
        line_item_proposals:
          type: array
          items:
            $ref: '#/components/schemas/LineItemProposal'
    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
    EmbeddedSupplier:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        email:
          type: string
        vetting_status:
          type: string
          enum:
            - NOT REGISTERED
            - PASSED
            - FAILED
            - PENDING
          example: NOT REGISTERED
        tax_number:
          type: string
        tax_registered:
          type: boolean
          example: true
    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
    EmbeddedProject:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string
        description:
          type: string
    BidMilestone:
      type: object
      properties:
        id:
          type: integer
        bid_id:
          type: integer
        title:
          type: string
        details:
          type: string
        rate:
          $ref: '#/components/schemas/Money'
        due_on:
          type: string
        mandatory:
          type: boolean
          example: true
        client_suggested:
          type: boolean
          example: true
        created_at:
          type: string
        updated_at:
          type: string
    LineItemProposal:
      type: object
      properties:
        id:
          type: integer
        item_type:
          type: string
          enum:
            - item
            - service
          example: item
        name:
          type: string
        manufacturer_name:
          type: string
        manufacturer_part_number:
          type: string
        quantity:
          type: string
        price:
          $ref: '#/components/schemas/Money'
        uom:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUom'
            - type: 'null'
        net_total_price:
          type: string
        custom_fields:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of custom field data
        created_at:
          type: string
        updated_at:
          type: string
        project_line_item:
          oneOf:
            - $ref: '#/components/schemas/ProjectLineItem'
            - type: 'null'
    EmbeddedUom:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        code:
          type: string
        active:
          type: boolean
          example: true
    ProjectLineItem:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        manufacturer_name:
          type: string
        manufacturer_part_number:
          type: string
        uom:
          type: string
        item:
          type: string
        item_type:
          type: string
          enum:
            - item
            - service
          example: item
        price:
          $ref: '#/components/schemas/Money'
        quantity:
          type: string
        net_total_price:
          type: string
        quantity_delivered:
          type: string
        quantity_undelivered:
          type: string
        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
  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.

````