List onboarded companies

Retrieve the companies available to the workspace resolved from the caller's API key. Use this endpoint to obtain the company identifier required by the branch and document-count APIs.

Endpoint

GET https://prod.gets.complyance.io/v3/connect/companies

This is a read-only endpoint. Results are scoped to the authenticated workspace and returned with pagination metadata.

Headers

Header	Required	Description
`X-API-Key`	Yes	Authenticates the caller and resolves its workspace and permissions.
`Accept`	No	Use `application/json`.

Do not send workspaceId. The API key resolves the workspace.

Query parameters

Parameter	Type	Required	Validation and meaning
`page`	integer	No	Page number starting at `1`. Defaults to `1`.
`limit`	integer	No	Results per page from `1` to `100`. Defaults to `20`.
`countryCode`	string	No	Filter by country code, such as `AE`.
`sourceVersion`	string	No	Filter by source version.
`status`	string	No	`active` or `inactive`.
`search`	string	No	Case-insensitive search across company and source identity fields.

Request example

curl --get 'https://prod.gets.complyance.io/v3/connect/companies' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --data-urlencode 'countryCode=AE' \
  --data-urlencode 'page=1' \
  --data-urlencode 'limit=100'

Success response

Status: 200 OK

{
  "success": true,
  "data": [
    {
      "id": "66b9f0a1c2d3e4f567890123",
      "sourceName": "accounting-platform",
      "sourceVersion": "2.1",
      "legalName": "Example UAE Entity",
      "countryCode": "AE",
      "status": "active",
      "createdAt": "2026-08-01T12:00:00.000Z",
      "updatedAt": "2026-08-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "requestId": "01JABCDEF1234567890REQUEST",
    "timestamp": "2026-08-01T12:00:00.000Z",
    "workspaceId": "66b9e000c2d3e4f567890000",
    "pagination": {
      "page": 1,
      "limit": 100,
      "total": 1
    },
    "filters": {
      "countryCode": "AE"
    }
  }
}

The response may contain additional company information. Integrations should depend only on documented fields.

Use `id` as `companyId`

The Company List API currently returns the company identifier as data[].id. This is the same opaque value named companyId by company onboarding, branch creation, and document-count endpoints.

For the example response:

data[0].id = 66b9f0a1c2d3e4f567890123
companyId  = 66b9f0a1c2d3e4f567890123

Use this value in endpoints such as:

POST /v3/connect/companies/66b9f0a1c2d3e4f567890123/branches/bulk
GET /v3/connect/invoices/counts?countryCode=AE&companyId=66b9f0a1c2d3e4f567890123

Treat the identifier as an opaque string. Do not derive it from the TIN, source ID, branch ID, Peppol participant ID, or workspace ID.

Pagination

Use meta.pagination.total to determine the number of matching companies. Increment page until all results have been retrieved. The maximum supported limit is 100.

An empty result is successful:

{
  "success": true,
  "data": [],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 0
    }
  }
}

Errors

Errors use the standard Connect API v3 error envelope.

HTTP status	Condition
`400`	A query parameter is malformed or outside its allowed range.
`401`	The API key is missing or invalid.
`403`	The caller cannot access Connect APIs for the resolved workspace.
`429`	The workspace exceeded its request limit. Honor `Retry-After`.
`500` / `503`	A required service is unavailable. Retain `meta.requestId` for support.

Next step: Use a returned data[].id as companyId when adding branches or retrieving document counts.