latestOpenAPI 3.0.32026-08-084947174.1 KB

f9302ec2ef8a

Companies

View Company details

get/companies/{id}

Path parameters

idstring uuid required

Resource UUID

Query parameters

includestring[]

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

Response

Success

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"
      }
    }
  }
}