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

> Retrieve a paginated list of suppliers. Use filters to narrow results.

## Filtering

Use the `filter[<attribute>]` parameter to filter results. Multiple filters are combined with AND logic.

### Basic Examples
```
# Equality (implicit)
GET /api/v4/suppliers?filter[vetting_status]=NOT REGISTERED

# Multiple values (implicit IN)
GET /api/v4/suppliers?filter[vetting_status]=NOT REGISTERED,FAILED

# With explicit operator
GET /api/v4/suppliers?filter[created_at][gte]=2024-01-01

# Range query
GET /api/v4/suppliers?filter[onboarding_template_id][between]=10,100

# Multiple filters (AND)
GET /api/v4/suppliers?filter[vetting_status]=NOT REGISTERED&filter[onboarding_template_id][gte]=10
```

### Available Attributes

| Attribute | Type | Operators | Permitted Values |
|-----------|------|-----------|------------------|
| archived_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| archived_reason | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| cis_contractor | boolean | `eq`, `not_eq` | - |
| cis_rate_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| company_registration_number | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| description | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| display_location | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| display_location_country_code | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| duns_number | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| headline | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| invited_by_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| linkedin_url | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| name | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| ni_number | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| onboarding_template_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| payment_terms_in_days | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| project_matches_count | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| tax_jurisdiction | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| tax_number | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| tax_registered | boolean | `eq`, `not_eq` | - |
| updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - |
| utr | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| uuid | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |
| vetting_status | string | `eq`, `not_eq`, `in`, `not_in` | `NOT REGISTERED`, `PASSED`, `FAILED`, `PENDING` |
| website | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - |

### Custom Fields

This resource supports custom field filtering using `cf[key]` syntax:
```
# Equality
GET /api/v4/suppliers?cf[priority]=high

# With operator
GET /api/v4/suppliers?cf[department][in]=engineering,design

# Check existence
GET /api/v4/suppliers?cf[priority][exists]=

# Negation
GET /api/v4/suppliers?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/suppliers?or[1][vetting_status]=PASSED&or[2][vetting_status]=NOT REGISTERED

# Complex OR (vetting_status=PASSED AND onboarding_template_id>=10) OR (vetting_status=NOT REGISTERED)
GET /api/v4/suppliers?or[1][vetting_status]=PASSED&or[1][onboarding_template_id][gte]=10&or[2][vetting_status]=NOT REGISTERED
```

## Sorting

Use `sort[<attribute>]` to order results. Default direction is ascending.
```
# Ascending (implicit)
GET /api/v4/suppliers?sort[created_at]=

# Descending
GET /api/v4/suppliers?sort[created_at]=desc

# Combined with filters
GET /api/v4/suppliers?filter[vetting_status]=NOT REGISTERED&sort[created_at]=desc
```



## OpenAPI

````yaml /api-reference/v4/openapi.json get /suppliers
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:
  /suppliers:
    get:
      tags:
        - Suppliers
      summary: List Suppliers
      description: >-
        Retrieve a paginated list of suppliers. Use filters to narrow results.


        ## Filtering


        Use the `filter[<attribute>]` parameter to filter results. Multiple
        filters are combined with AND logic.


        ### Basic Examples

        ```

        # Equality (implicit)

        GET /api/v4/suppliers?filter[vetting_status]=NOT REGISTERED


        # Multiple values (implicit IN)

        GET /api/v4/suppliers?filter[vetting_status]=NOT REGISTERED,FAILED


        # With explicit operator

        GET /api/v4/suppliers?filter[created_at][gte]=2024-01-01


        # Range query

        GET /api/v4/suppliers?filter[onboarding_template_id][between]=10,100


        # Multiple filters (AND)

        GET /api/v4/suppliers?filter[vetting_status]=NOT
        REGISTERED&filter[onboarding_template_id][gte]=10

        ```


        ### Available Attributes


        | Attribute | Type | Operators | Permitted Values |

        |-----------|------|-----------|------------------|

        | archived_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | archived_reason | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | cis_contractor | boolean | `eq`, `not_eq` | - |

        | cis_rate_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`,
        `lt`, `lte`, `between` | - |

        | company_registration_number | string | `eq`, `not_eq`, `in`, `not_in`,
        `like`, `not_like` | - |

        | created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | description | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | display_location | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | display_location_country_code | string | `eq`, `not_eq`, `in`,
        `not_in`, `like`, `not_like` | - |

        | duns_number | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | headline | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`
        | - |

        | id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`,
        `lte`, `between` | - |

        | invited_by_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`,
        `lt`, `lte`, `between` | - |

        | linkedin_url | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | name | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | -
        |

        | ni_number | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | onboarding_template_id | integer | `eq`, `not_eq`, `in`, `not_in`,
        `gt`, `gte`, `lt`, `lte`, `between` | - |

        | payment_terms_in_days | integer | `eq`, `not_eq`, `in`, `not_in`,
        `gt`, `gte`, `lt`, `lte`, `between` | - |

        | project_matches_count | integer | `eq`, `not_eq`, `in`, `not_in`,
        `gt`, `gte`, `lt`, `lte`, `between` | - |

        | tax_jurisdiction | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | tax_number | string | `eq`, `not_eq`, `in`, `not_in`, `like`,
        `not_like` | - |

        | tax_registered | boolean | `eq`, `not_eq` | - |

        | updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`,
        `between` | - |

        | utr | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | -
        |

        | uuid | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | -
        |

        | vetting_status | string | `eq`, `not_eq`, `in`, `not_in` | `NOT
        REGISTERED`, `PASSED`, `FAILED`, `PENDING` |

        | website | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like`
        | - |


        ### Custom Fields


        This resource supports custom field filtering using `cf[key]` syntax:

        ```

        # Equality

        GET /api/v4/suppliers?cf[priority]=high


        # With operator

        GET /api/v4/suppliers?cf[department][in]=engineering,design


        # Check existence

        GET /api/v4/suppliers?cf[priority][exists]=


        # Negation

        GET /api/v4/suppliers?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/suppliers?or[1][vetting_status]=PASSED&or[2][vetting_status]=NOT
        REGISTERED


        # Complex OR (vetting_status=PASSED AND onboarding_template_id>=10) OR
        (vetting_status=NOT REGISTERED)

        GET
        /api/v4/suppliers?or[1][vetting_status]=PASSED&or[1][onboarding_template_id][gte]=10&or[2][vetting_status]=NOT
        REGISTERED

        ```


        ## Sorting


        Use `sort[<attribute>]` to order results. Default direction is
        ascending.

        ```

        # Ascending (implicit)

        GET /api/v4/suppliers?sort[created_at]=


        # Descending

        GET /api/v4/suppliers?sort[created_at]=desc


        # Combined with filters

        GET /api/v4/suppliers?filter[vetting_status]=NOT
        REGISTERED&sort[created_at]=desc

        ```
      operationId: getSuppliers
      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[<attribute>]
          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): cis_rate_id, id, invited_by_id, onboarding_template_id,
            payment_terms_in_days, project_matches_count

            **datetime** (operators: eq, not_eq, gt, gte, lt, lte, between):
            archived_at, created_at, updated_at

            **string** (operators: eq, not_eq, in, not_in, like, not_like):
            archived_reason, company_registration_number, description,
            display_location, display_location_country_code, duns_number,
            headline, linkedin_url, name, ni_number, tax_jurisdiction,
            tax_number, utr, uuid, vetting_status (one of: NOT REGISTERED,
            PASSED, FAILED, PENDING), website

            **boolean** (operators: eq, not_eq): cis_contractor, tax_registered


            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:
                vetting_status: NOT REGISTERED
            multiple_values:
              summary: Multiple values (implicit IN)
              value:
                vetting_status: NOT REGISTERED,FAILED
            with_operator:
              summary: With explicit operator
              value:
                created_at:
                  gte: '2024-01-01'
            range:
              summary: Range query
              value:
                onboarding_template_id:
                  between: 10,100
        - 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][<attribute>]=value` or
            `or[group_key][<attribute>][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':
                  vetting_status: PASSED
                '2':
                  vetting_status: NOT REGISTERED
            complex_or:
              summary: Complex OR with AND within groups
              value:
                '1':
                  vetting_status: PASSED
                  onboarding_template_id:
                    gte: '10'
                '2':
                  vetting_status: NOT REGISTERED
        - 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[<attribute>]
          in: query
          style: deepObject
          explode: true
          schema:
            type: object
          description: >-
            Sort results by attribute. Direction defaults to ascending.


            **Syntax**: `sort[<attribute>]=` (ascending) or
            `sort[<attribute>]=desc` (descending)


            **Sortable attributes**: archived_at, archived_reason,
            cis_contractor, cis_rate_id, company_registration_number,
            created_at, description, display_location,
            display_location_country_code, duns_number, headline, id,
            invited_by_id, linkedin_url, name, ni_number,
            onboarding_template_id, payment_terms_in_days,
            project_matches_count, tax_jurisdiction, tax_number, tax_registered,
            updated_at, utr, uuid, vetting_status, website


            **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 suppliers
          content:
            application/json:
              schema:
                type: object
                properties:
                  suppliers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Supplier'
              examples:
                success:
                  summary: Successful response with suppliers
                  value:
                    suppliers:
                      - id: 101
                        name: Acme Corporation
                        description: Complete redesign of corporate website with modern UX
                        headline: Example headline
                        tax_number: Example tax_number
                        tax_registered: true
                        tax_jurisdiction: Example tax_jurisdiction
                        duns_number: Example duns_number
                        utr: Example utr
                        ni_number: Example ni_number
                        company_registration_number: Example company_registration_number
                        website: Example website
                        display_location: Example display_location
                        display_location_country_code: Example display_location_country_code
                        vetting_status: PASSED
                        uuid: Example uuid
                        onboarding_template_id: 501
                        linkedin_url: Example linkedin_url
                        cis_contractor: null
                        cis_rate:
                          id: 101
                          label: Example label
                          country_code: Example country_code
                          rate: '1500.00'
                          domestic_recharge: true
                          tax_reference: 101
                          archived: true
                          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'
                        payment_terms_in_days: 30
                        primary_address: null
                        invoice_address: null
                        onboarding_template_name: null
                        admin_custom_fields: null
                        accreditations: null
                        skills: null
                        supplier_risk_factors: null
                        badges:
                          - urgent
                          - featured
                        invited_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
                        archived_at: '2024-01-16T10:30:00+00:00'
                        archived_reason: Example archived_reason
                        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_matches_count: 5
                      - id: 102
                        name: Global Services Ltd
                        description: Native iOS and Android application
                        headline: Example headline
                        tax_number: Example tax_number
                        tax_registered: true
                        tax_jurisdiction: Example tax_jurisdiction
                        duns_number: Example duns_number
                        utr: Example utr
                        ni_number: Example ni_number
                        company_registration_number: Example company_registration_number
                        website: Example website
                        display_location: Example display_location
                        display_location_country_code: Example display_location_country_code
                        vetting_status: FAILED
                        uuid: Example uuid
                        onboarding_template_id: 502
                        linkedin_url: Example linkedin_url
                        cis_contractor: null
                        cis_rate:
                          id: 102
                          label: Example label
                          country_code: Example country_code
                          rate: '1500.00'
                          domestic_recharge: true
                          tax_reference: 102
                          archived: true
                          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'
                        payment_terms_in_days: 30
                        primary_address: null
                        invoice_address: null
                        onboarding_template_name: null
                        admin_custom_fields: null
                        accreditations: null
                        skills: null
                        supplier_risk_factors: null
                        badges:
                          - urgent
                          - featured
                        invited_by:
                          id: 102
                          first_name: Jane
                          last_name: Smith
                          email: user2@example.com
                          org_id: 502
                          org_name: Global Services Ltd
                        archived_at: '2024-01-17T10:30:00+00:00'
                        archived_reason: Example archived_reason
                        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_matches_count: 10
                empty:
                  summary: Empty result set
                  value:
                    suppliers: []
                filtered:
                  summary: Filtered results
                  description: Results after applying filters
                  value:
                    suppliers:
                      - id: 101
                        name: Acme Corporation
                        description: Complete redesign of corporate website with modern UX
                        headline: Example headline
                        tax_number: Example tax_number
                        tax_registered: true
                        tax_jurisdiction: Example tax_jurisdiction
                        duns_number: Example duns_number
                        utr: Example utr
                        ni_number: Example ni_number
                        company_registration_number: Example company_registration_number
                        website: Example website
                        display_location: Example display_location
                        display_location_country_code: Example display_location_country_code
                        vetting_status: PASSED
                        uuid: Example uuid
                        onboarding_template_id: 501
                        linkedin_url: Example linkedin_url
                        cis_contractor: null
                        cis_rate:
                          id: 101
                          label: Example label
                          country_code: Example country_code
                          rate: '1500.00'
                          domestic_recharge: true
                          tax_reference: 101
                          archived: true
                          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'
                        payment_terms_in_days: 30
                        primary_address: null
                        invoice_address: null
                        onboarding_template_name: null
                        admin_custom_fields: null
                        accreditations: null
                        skills: null
                        supplier_risk_factors: null
                        badges:
                          - urgent
                          - featured
                        invited_by:
                          id: 101
                          first_name: Demo
                          last_name: User
                          email: user1@example.com
                          org_id: 501
                          org_name: Acme Corporation
                        archived_at: '2024-01-16T10:30:00+00:00'
                        archived_reason: Example archived_reason
                        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_matches_count: 5
        '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: suppliers: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:
            - suppliers:read
          tenantId: []
components:
  schemas:
    Supplier:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        headline:
          type: string
        tax_number:
          type: string
        tax_registered:
          type: boolean
          example: true
        tax_jurisdiction:
          type: string
        duns_number:
          type: string
        utr:
          type: string
        ni_number:
          type: string
        company_registration_number:
          type: string
        website:
          type: string
        display_location:
          type: string
        display_location_country_code:
          type: string
        vetting_status:
          type: string
          enum:
            - NOT REGISTERED
            - PASSED
            - FAILED
            - PENDING
          example: NOT REGISTERED
        uuid:
          type: string
        onboarding_template_id:
          type: integer
        linkedin_url:
          type: string
        cis_contractor:
          type: boolean
          example: true
        cis_rate:
          oneOf:
            - $ref: '#/components/schemas/TaxType'
            - type: 'null'
        payment_terms_in_days:
          type: integer
        primary_address:
          $ref: '#/components/schemas/Address'
        invoice_address:
          $ref: '#/components/schemas/Address'
        onboarding_template_name:
          type: string
        admin_custom_fields:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of custom field data
        accreditations:
          type: string
        skills:
          type: string
        supplier_risk_factors:
          type: string
        badges:
          type: array
          items:
            type: string
        invited_by:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedUser'
            - type: 'null'
        archived_at:
          type: string
        archived_reason:
          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_matches_count:
          type: integer
    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
    TaxType:
      type: object
      properties:
        id:
          type: integer
        label:
          type: string
        country_code:
          type: string
        rate:
          type: string
        domestic_recharge:
          type: boolean
          example: true
        tax_reference:
          type: integer
        archived:
          type: boolean
          example: true
        custom_fields:
          type: object
          additionalProperties:
            type: string
          description: Key-value pairs of custom field data
        created_at:
          type: string
        updated_at:
          type: string
    Address:
      type: object
      properties:
        id:
          type: integer
        line1:
          type: string
        line2:
          type: string
        city:
          type: string
        region:
          type: string
        postcode:
          type: string
        country_code:
          type: string
        formatted:
          type: string
    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.

````