Sign in
latestOpenAPI 3.0.32026-08-084947174.1 KB

f9302ec2ef8a

Companies

List Companies

get/companies

Query parameters

limitinteger

Maximum number of results per page

pageinteger

Page number to retrieve

includestring[]

Comma-separated list of related resources to include for companies.

filter[account_id]string uuid
Example:123e4567-e89b-12d3-a456-426614174000

Filter the collection by the specific Account UUID. Value MUST be a canonical UUID string (8-4-4-4-12). Example: 123e4567-e89b-12d3-a456-426614174000.

Response

Success

has_moreboolean

Indicates if there are more results available beyond the current page.

Example response

{
  "data": [
    {
      "domicile": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "principal_address": {
        "administrative_area": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "mailing_address": {
        "administrative_area": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }
  ]
}