> ## 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 Orgs > Retrieve a paginated list of orgs. 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/orgs?filter[name]=active # Multiple values (implicit IN) GET /api/v4/orgs?filter[name]=draft,pending # With explicit operator GET /api/v4/orgs?filter[created_at][gte]=2024-01-01 # Range query GET /api/v4/orgs?filter[supplier_id][between]=10,100 # Multiple filters (AND) GET /api/v4/orgs?filter[name]=active&filter[supplier_id][gte]=10 ``` ### Available Attributes | Attribute | Type | Operators | Permitted Values | |-----------|------|-----------|------------------| | ai_services | boolean | `eq`, `not_eq` | - | | archived_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | billing_email | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | cis_contractor | boolean | `eq`, `not_eq` | - | | created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | external_ref | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | financial_year_end_day | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | financial_year_end_month | 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` | - | | is_external_client | boolean | `eq`, `not_eq` | - | | is_supplier | boolean | `eq`, `not_eq` | - | | linkedin_url | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | name | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | payment_terms_in_days | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | scopeiq_share_ai_usage | boolean | `eq`, `not_eq` | - | | supplier_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | time_zone | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | url | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | uuid | 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/orgs?cf[priority]=high # With operator GET /api/v4/orgs?cf[department][in]=engineering,design # Check existence GET /api/v4/orgs?cf[priority][exists]= # Negation GET /api/v4/orgs?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/orgs?or[1][name]=pending&or[2][name]=active # Complex OR (name=pending AND supplier_id>=10) OR (name=active) GET /api/v4/orgs?or[1][name]=pending&or[1][supplier_id][gte]=10&or[2][name]=active ``` ## Sorting Use `sort[]` to order results. Default direction is ascending. ``` # Ascending (implicit) GET /api/v4/orgs?sort[created_at]= # Descending GET /api/v4/orgs?sort[created_at]=desc # Combined with filters GET /api/v4/orgs?filter[name]=active&sort[created_at]=desc ``` ## OpenAPI ````yaml /api-reference/v4/openapi.json get /orgs 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: /orgs: get: tags: - Orgs summary: List Orgs description: >- Retrieve a paginated list of orgs. 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/orgs?filter[name]=active # Multiple values (implicit IN) GET /api/v4/orgs?filter[name]=draft,pending # With explicit operator GET /api/v4/orgs?filter[created_at][gte]=2024-01-01 # Range query GET /api/v4/orgs?filter[supplier_id][between]=10,100 # Multiple filters (AND) GET /api/v4/orgs?filter[name]=active&filter[supplier_id][gte]=10 ``` ### Available Attributes | Attribute | Type | Operators | Permitted Values | |-----------|------|-----------|------------------| | ai_services | boolean | `eq`, `not_eq` | - | | archived_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | billing_email | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | cis_contractor | boolean | `eq`, `not_eq` | - | | created_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | external_ref | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | financial_year_end_day | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | financial_year_end_month | 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` | - | | is_external_client | boolean | `eq`, `not_eq` | - | | is_supplier | boolean | `eq`, `not_eq` | - | | linkedin_url | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | name | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | payment_terms_in_days | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | scopeiq_share_ai_usage | boolean | `eq`, `not_eq` | - | | supplier_id | integer | `eq`, `not_eq`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `between` | - | | time_zone | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | updated_at | datetime | `eq`, `not_eq`, `gt`, `gte`, `lt`, `lte`, `between` | - | | url | string | `eq`, `not_eq`, `in`, `not_in`, `like`, `not_like` | - | | uuid | 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/orgs?cf[priority]=high # With operator GET /api/v4/orgs?cf[department][in]=engineering,design # Check existence GET /api/v4/orgs?cf[priority][exists]= # Negation GET /api/v4/orgs?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/orgs?or[1][name]=pending&or[2][name]=active # Complex OR (name=pending AND supplier_id>=10) OR (name=active) GET /api/v4/orgs?or[1][name]=pending&or[1][supplier_id][gte]=10&or[2][name]=active ``` ## Sorting Use `sort[]` to order results. Default direction is ascending. ``` # Ascending (implicit) GET /api/v4/orgs?sort[created_at]= # Descending GET /api/v4/orgs?sort[created_at]=desc # Combined with filters GET /api/v4/orgs?filter[name]=active&sort[created_at]=desc ``` operationId: getOrgs 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): financial_year_end_day, financial_year_end_month, id, payment_terms_in_days, supplier_id **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): billing_email, external_ref, linkedin_url, name, time_zone, url, uuid **boolean** (operators: eq, not_eq): ai_services, cis_contractor, is_external_client, is_supplier, scopeiq_share_ai_usage 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: name: active multiple_values: summary: Multiple values (implicit IN) value: name: draft,pending with_operator: summary: With explicit operator value: created_at: gte: '2024-01-01' range: summary: Range query value: supplier_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][]=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': name: pending '2': name: active complex_or: summary: Complex OR with AND within groups value: '1': name: pending supplier_id: gte: '10' '2': name: active - 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**: ai_services, archived_at, billing_email, cis_contractor, created_at, external_ref, financial_year_end_day, financial_year_end_month, id, is_external_client, is_supplier, linkedin_url, name, payment_terms_in_days, scopeiq_share_ai_usage, supplier_id, time_zone, updated_at, url, uuid **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 orgs content: application/json: schema: type: object properties: orgs: type: array items: $ref: '#/components/schemas/Org' examples: success: summary: Successful response with orgs value: orgs: - id: 101 uuid: Example uuid external_ref: Example external_ref name: Acme Corporation is_external_client: true is_supplier: true supplier_id: 501 url: Example url linkedin_url: Example linkedin_url billing_email: Example billing_email address: null invoice_address: null payment_terms_in_days: 30 cis_contractor: null financial_year_end_day: 101 financial_year_end_month: 101 time_zone: Example time_zone ai_services: true scopeiq_share_ai_usage: true custom_fields: department: Engineering priority: high cost_code: CC-001 settings: default_fee_methodology: null cis_contractor: false payment_terms_in_days: null archived_at: '2024-01-16T10:30:00+00:00' created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' cost_centers: - id: 101 org_id: 501 name: Acme Corporation code: Example code external_ref: Example external_ref is_active: true created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' - id: 102 org_id: 502 name: Global Services Ltd code: Example code external_ref: Example external_ref is_active: true created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' org_units: - id: 101 org_id: 501 parent_id: 501 name: Acme Corporation unit_type: 101 external_ref: Example external_ref created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' - id: 102 org_id: 502 parent_id: 502 name: Global Services Ltd unit_type: 102 external_ref: Example external_ref created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' org_users: - id: 101 first_name: Demo last_name: User email: user1@example.com org_id: 501 org_name: Acme Corporation - id: 102 first_name: Jane last_name: Smith email: user2@example.com org_id: 502 org_name: Global Services Ltd - id: 102 uuid: Example uuid external_ref: Example external_ref name: Global Services Ltd is_external_client: true is_supplier: true supplier_id: 502 url: Example url linkedin_url: Example linkedin_url billing_email: Example billing_email address: null invoice_address: null payment_terms_in_days: 30 cis_contractor: null financial_year_end_day: 102 financial_year_end_month: 102 time_zone: Example time_zone ai_services: true scopeiq_share_ai_usage: true custom_fields: department: Engineering priority: high cost_code: CC-001 settings: default_fee_methodology: null cis_contractor: false payment_terms_in_days: null archived_at: '2024-01-17T10:30:00+00:00' created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' cost_centers: - id: 102 org_id: 502 name: Global Services Ltd code: Example code external_ref: Example external_ref is_active: true created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' - id: 103 org_id: 503 name: Global Services Ltd code: Example code external_ref: Example external_ref is_active: true created_at: '2024-01-18T10:30:00+00:00' updated_at: '2024-01-18T10:30:00+00:00' org_units: - id: 102 org_id: 502 parent_id: 502 name: Global Services Ltd unit_type: 102 external_ref: Example external_ref created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' - id: 103 org_id: 503 parent_id: 503 name: Global Services Ltd unit_type: 103 external_ref: Example external_ref created_at: '2024-01-18T10:30:00+00:00' updated_at: '2024-01-18T10:30:00+00:00' org_users: - id: 102 first_name: Jane last_name: Smith email: user2@example.com org_id: 502 org_name: Global Services Ltd - id: 103 first_name: Jane last_name: Smith email: user3@example.com org_id: 503 org_name: Global Services Ltd empty: summary: Empty result set value: orgs: [] filtered: summary: Filtered results description: Results after applying filters value: orgs: - id: 101 uuid: Example uuid external_ref: Example external_ref name: Acme Corporation is_external_client: true is_supplier: true supplier_id: 501 url: Example url linkedin_url: Example linkedin_url billing_email: Example billing_email address: null invoice_address: null payment_terms_in_days: 30 cis_contractor: null financial_year_end_day: 101 financial_year_end_month: 101 time_zone: Example time_zone ai_services: true scopeiq_share_ai_usage: true custom_fields: department: Engineering priority: high cost_code: CC-001 settings: default_fee_methodology: null cis_contractor: false payment_terms_in_days: null archived_at: '2024-01-16T10:30:00+00:00' created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' cost_centers: - id: 101 org_id: 501 name: Acme Corporation code: Example code external_ref: Example external_ref is_active: true created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' - id: 102 org_id: 502 name: Global Services Ltd code: Example code external_ref: Example external_ref is_active: true created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' org_units: - id: 101 org_id: 501 parent_id: 501 name: Acme Corporation unit_type: 101 external_ref: Example external_ref created_at: '2024-01-16T10:30:00+00:00' updated_at: '2024-01-16T10:30:00+00:00' - id: 102 org_id: 502 parent_id: 502 name: Global Services Ltd unit_type: 102 external_ref: Example external_ref created_at: '2024-01-17T10:30:00+00:00' updated_at: '2024-01-17T10:30:00+00:00' org_users: - id: 101 first_name: Demo last_name: User email: user1@example.com org_id: 501 org_name: Acme Corporation - id: 102 first_name: Jane last_name: Smith email: user2@example.com org_id: 502 org_name: Global Services Ltd '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: orgs: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: - orgs:read tenantId: [] components: schemas: Org: type: object properties: id: type: integer uuid: type: string external_ref: type: string name: type: string is_external_client: type: boolean example: true is_supplier: type: boolean example: true supplier_id: type: integer url: type: string linkedin_url: type: string billing_email: type: string address: $ref: '#/components/schemas/Address' invoice_address: $ref: '#/components/schemas/Address' payment_terms_in_days: type: integer cis_contractor: type: boolean example: true financial_year_end_day: type: integer financial_year_end_month: type: integer time_zone: type: string ai_services: type: boolean example: true scopeiq_share_ai_usage: type: boolean example: true custom_fields: type: object additionalProperties: type: string description: Key-value pairs of custom field data settings: type: object properties: default_fee_methodology: type: string cis_contractor: type: boolean payment_terms_in_days: type: integer archived_at: type: string created_at: type: string updated_at: type: string cost_centers: type: array items: $ref: '#/components/schemas/CostCenter' org_units: type: array items: $ref: '#/components/schemas/OrgUnit' org_users: type: array items: $ref: '#/components/schemas/EmbeddedUser' 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 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 CostCenter: type: object properties: id: type: integer org_id: type: integer name: type: string code: type: string external_ref: type: string is_active: type: boolean example: true created_at: type: string updated_at: type: string OrgUnit: type: object properties: id: type: integer org_id: type: integer parent_id: type: integer name: type: string unit_type: type: integer external_ref: type: string created_at: type: string updated_at: 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. ````