> ## 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. # List Bids > Retrieve a paginated list of bids. Use filters to narrow results. ## Filtering Use the `filter[]` parameter to filter results. Multiple filters are combined with AND logic. ### Basic Examples ``` # Equality (implicit) GET /api/v4/bids?filter[status]=draft # Multiple values (implicit IN) GET /api/v4/bids?filter[status]=draft,superseded # With explicit operator GET /api/v4/bids?filter[created_at][gte]=2024-01-01 # Range query GET /api/v4/bids?filter[rate][between]=1000000,5000000 # Multiple filters (AND) GET /api/v4/bids?filter[status]=draft&filter[rate][gte]=1000000 ``` ### Available Attributes | Attribute | Type | Operators | Permitted Values | |-----------|------|-----------|------------------| | bafo | boolean | `eq`, `not_eq` | - | | cost_score_auto | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | cost_score_override | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | eliminated | boolean | `eq`, `not_eq` | - | | fee | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | hired | boolean | `eq`, `not_eq` | - | | hours | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | managed_bid | boolean | `eq`, `not_eq` | - | | project_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | proposal | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | quality_score | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | rate | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | rate_ccy | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | read_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | selected | boolean | `eq` | `true`, `false` | | selected_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | shortlisted | boolean | `eq` | `true`, `false` | | shortlisted_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | source | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | status | string | `eq`, `not_eq`, `in`, `not_in` | `draft`, `submitted`, `superseded`, `withdrawn` | | submitted_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | supplier_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | total_score | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | user_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | version | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | ### Custom Fields This resource supports custom field filtering using `cf[key]` syntax: ``` # Equality GET /api/v4/bids?cf[priority]=high # With operator GET /api/v4/bids?cf[department][in]=engineering,design # Check existence GET /api/v4/bids?cf[priority][exists]= # Negation GET /api/v4/bids?cf[priority][not_eq]=low ``` ### OR Conditions Use `or[group]` to combine filter groups with OR logic. Filters within a group are ANDed: ``` # Simple OR GET /api/v4/bids?or[1][status]=submitted&or[2][status]=draft # Complex OR (status=submitted AND rate>=1000000) OR (status=draft) GET /api/v4/bids?or[1][status]=submitted&or[1][rate][gte]=1000000&or[2][status]=draft ``` ## Sorting Use `sort[]` to order results. Default direction is ascending. ``` # Ascending (implicit) GET /api/v4/bids?sort[created_at]= # Descending GET /api/v4/bids?sort[created_at]=desc # Combined with filters GET /api/v4/bids?filter[status]=draft&sort[created_at]=desc ``` ## OpenAPI ````yaml /api-reference/v4/openapi.json get /bids 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: get: tags: - Bids summary: List Bids description: >- Retrieve a paginated list of bids. Use filters to narrow results. ## Filtering Use the `filter[]` parameter to filter results. Multiple filters are combined with AND logic. ### Basic Examples ``` # Equality (implicit) GET /api/v4/bids?filter[status]=draft # Multiple values (implicit IN) GET /api/v4/bids?filter[status]=draft,superseded # With explicit operator GET /api/v4/bids?filter[created_at][gte]=2024-01-01 # Range query GET /api/v4/bids?filter[rate][between]=1000000,5000000 # Multiple filters (AND) GET /api/v4/bids?filter[status]=draft&filter[rate][gte]=1000000 ``` ### Available Attributes | Attribute | Type | Operators | Permitted Values | |-----------|------|-----------|------------------| | bafo | boolean | `eq`, `not_eq` | - | | cost_score_auto | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | cost_score_override | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | eliminated | boolean | `eq`, `not_eq` | - | | fee | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | hired | boolean | `eq`, `not_eq` | - | | hours | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | managed_bid | boolean | `eq`, `not_eq` | - | | project_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | proposal | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | quality_score | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | rate | money | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | rate_ccy | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | read_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | selected | boolean | `eq` | `true`, `false` | | selected_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | shortlisted | boolean | `eq` | `true`, `false` | | shortlisted_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | source | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | status | string | `eq`, `not_eq`, `in`, `not_in` | `draft`, `submitted`, `superseded`, `withdrawn` | | submitted_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | supplier_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | total_score | decimal | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | user_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | version | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | ### Custom Fields This resource supports custom field filtering using `cf[key]` syntax: ``` # Equality GET /api/v4/bids?cf[priority]=high # With operator GET /api/v4/bids?cf[department][in]=engineering,design # Check existence GET /api/v4/bids?cf[priority][exists]= # Negation GET /api/v4/bids?cf[priority][not_eq]=low ``` ### OR Conditions Use `or[group]` to combine filter groups with OR logic. Filters within a group are ANDed: ``` # Simple OR GET /api/v4/bids?or[1][status]=submitted&or[2][status]=draft # Complex OR (status=submitted AND rate>=1000000) OR (status=draft) GET /api/v4/bids?or[1][status]=submitted&or[1][rate][gte]=1000000&or[2][status]=draft ``` ## Sorting Use `sort[]` to order results. Default direction is ascending. ``` # Ascending (implicit) GET /api/v4/bids?sort[created_at]= # Descending GET /api/v4/bids?sort[created_at]=desc # Combined with filters GET /api/v4/bids?filter[status]=draft&sort[created_at]=desc ``` operationId: getBids parameters: - name: page in: query schema: type: integer default: 1 description: Page number for pagination - name: limit in: query schema: type: integer default: 20 maximum: 100 description: Number of results per page (max 100) - name: filter[] in: query style: deepObject explode: true schema: type: object description: >- Filterable attributes: **integer** (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): hours, id, project_id, supplier_id, user_id, version **datetime** (operators: eq, not_eq, gt, gte, lt, lte, between): created_at, read_at, selected_at, shortlisted_at, submitted_at, updated_at **money** (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): rate **string** (operators: eq, not_eq, in, not_in, like, not_like): proposal, rate_ccy, source, status (one of: draft = saved by supplier, not yet submitted to client; submitted = submitted to client, pending a decision; superseded = replaced by a newer version of this bid; withdrawn = withdrawn by the supplier) **decimal** (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): cost_score_auto, cost_score_override, fee, quality_score, total_score **boolean** (operators: eq, not_eq): bafo, eliminated, hired, managed_bid, selected (one of: true = selected as a preferred supplier by the client (selected_at is set); false = not selected as a preferred supplier), shortlisted (one of: true = on the project shortlist (shortlisted_at is set); false = not shortlisted) Note: money values are in minor currency units (e.g. pence for GBP). Use 1000000 for £10,000.00. Note: `like` is a case-insensitive substring match — pass the bare term (filter[title][like]=redesign). Do not add % wildcards; they are not needed. examples: equality: summary: Simple equality value: status: draft multiple_values: summary: Multiple values (implicit IN) value: status: draft,superseded with_operator: summary: With explicit operator value: created_at: gte: '2024-01-01' range: summary: Range query value: rate: between: 1000000,5000000 - name: or[group] in: query style: deepObject explode: true schema: type: object description: >- OR condition groups. Filters within a group are ANDed; groups are ORed. **Syntax**: `or[group_key][]=value` or `or[group_key][][operator]=value` **Examples**: - Simple OR: `or[1][state]=draft&or[2][state]=pending` - Complex: `or[1][state]=draft&or[1][budget][gte]=50000&or[2][state]=closed` - With custom fields: `or[1][cf][priority]=high&or[2][state]=pending` Group keys can be any string (1, 2, a, b, etc.) - they just need to be unique. examples: simple_or: summary: Simple OR value: '1': status: submitted '2': status: draft complex_or: summary: Complex OR with AND within groups value: '1': status: submitted rate: gte: '1000000' '2': status: draft - name: cf[key] in: query style: deepObject explode: true schema: type: object description: >- Custom field filters using concise syntax. **Syntax**: - Equality: `cf[key]=value` - With operator: `cf[key][operator]=value` **Operators**: eq (default), not_eq, in, not_in, contains, not_contains, exists, not_exists **Examples**: - `cf[priority]=high` - exact match - `cf[department][in]=eng,design` - matches any - `cf[priority][not_eq]=low` - not equal - `cf[notes][contains]=urgent` - contains text - `cf[legacy_field][exists]=` - field exists (value ignored) - `cf[deprecated][not_exists]=` - field does not exist examples: equality: summary: Simple equality value: priority: high with_operator: summary: With IN operator value: department: in: eng,design exists: summary: Check existence value: priority: exists: '' - name: or[group][cf][key] in: query style: deepObject explode: true schema: type: object description: >- Custom field filters within OR condition groups. **Syntax**: `or[group][cf][key]=value` or `or[group][cf][key][operator]=value` **Example**: `or[1][cf][priority]=high&or[2][state]=pending` - name: sort[] in: query style: deepObject explode: true schema: type: object description: >- Sort results by attribute. Direction defaults to ascending. **Syntax**: `sort[]=` (ascending) or `sort[]=desc` (descending) **Sortable attributes**: bafo, cost_score_auto, cost_score_override, created_at, eliminated, fee, hired, hours, id, managed_bid, project_id, proposal, quality_score, rate, rate_ccy, read_at, selected, selected_at, shortlisted, shortlisted_at, source, status, submitted_at, supplier_id, total_score, updated_at, user_id, version **Examples**: - Ascending: `sort[created_at]=` or `sort[created_at]=asc` - Descending: `sort[created_at]=desc` examples: ascending: summary: Ascending (implicit) value: created_at: '' descending: summary: Descending value: created_at: desc responses: '200': description: List of bids content: application/json: schema: type: object properties: bids: type: array items: $ref: '#/components/schemas/Bid' examples: success: summary: Successful response with bids value: bids: - 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 - id: 102 rate: cents: 300000 currency: GBP fee: '1500.00' proposal: Example proposal supplier: id: 102 name: Global Services Ltd email: user2@example.com vetting_status: FAILED tax_number: Example tax_number tax_registered: true user: id: 102 first_name: Jane last_name: Smith email: user2@example.com org_id: 502 org_name: Global Services Ltd version: 102 status: superseded managed_bid: true bafo: true submitted_at: '2024-01-17T10:30:00+00:00' read_at: '2024-01-17T10:30:00+00:00' shortlisted_at: '2024-01-17T10:30:00+00:00' selected_at: '2024-01-17T10:30:00+00:00' hours: 102 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-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' project: id: 102 title: Mobile App Development description: Native iOS and Android application bid_milestones: - 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' - id: 103 bid_id: 503 title: Mobile App Development details: >- Additional information and context for this record. rate: cents: 450000 currency: GBP due_on: '2024-01-18' mandatory: false client_suggested: false created_at: '2024-01-18T10:30:00+00:00' updated_at: '2024-01-18T10:30:00+00:00' line_item_proposals: - 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 - id: 103 item_type: service name: Global Services Ltd manufacturer_name: Example manufacturer_name manufacturer_part_number: Example manufacturer_part_number quantity: '1500.00' price: cents: 450000 currency: GBP uom: id: 103 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-18T10:30:00+00:00' updated_at: '2024-01-18T10:30:00+00:00' project_line_item: id: 103 name: Global Services Ltd manufacturer_name: Example manufacturer_name manufacturer_part_number: Example manufacturer_part_number uom: null item: null item_type: service price: cents: 450000 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-18T10:30:00+00:00' updated_at: '2024-01-18T10:30:00+00:00' project_id: 503 empty: summary: Empty result set value: bids: [] filtered: summary: Filtered results description: Results after applying filters value: bids: - 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 content: application/json: schema: $ref: '#/components/schemas/Error' example: error: insufficient_scope error_description: >- The request requires higher privileges than provided by the access token required_scope: bids:read provided_scopes: - welcome:read '422': description: Invalid filter or sort parameters content: application/json: schema: $ref: '#/components/schemas/Error' examples: invalid_attribute: summary: Unknown filter attribute value: error: 'Invalid filter attribute: unknown_field' invalid_operator: summary: Invalid operator for type value: error: Operator 'like' is not valid for integer type invalid_value: summary: Invalid value format value: error: 'Invalid date format for created_at: not-a-date' invalid_sort_attribute: summary: Unknown sort attribute value: error: 'Invalid sort attribute: unknown_field' invalid_sort_direction: summary: Invalid sort direction value: error: Invalid sort direction 'random'. Must be 'asc' or 'desc' 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. ````