Companies page
Produced by POST /api/v2/bulk/companies/search; the task reports "requestType": "BulkGetCompanies". One file per page of companies, each a complete document — see Result files for how pages are delivered and the conventions they share. The certified companies workflow shows it joined against the standard-holders export.
This export carries company information only. Issued standards live in the standard holders page, joined on the company id.
Top level
| Field | Type | Notes |
|---|---|---|
customProperties | CustomProperty[] | { id, name } for the requested properties that at least one company in the export holds a value for. Drawn from the whole export and identical on every page, so every key in this page's companies[].fields resolves here — and the catalog may also name a property only another page's companies hold. Absent when the request asked for no custom properties. |
companies | Company[] | The page's companies. |
Company
| Field | Type | Notes |
|---|---|---|
id | uuid | The company id the rest of the API uses. |
historicalIds | uuid[] | Ids the company held before profile merges. Keep them in a join so references you stored under an old id still resolve. Absent when there are none. |
name | string | |
website | string | Absent when unknown. |
fields | object | Keyed by custom-property id, each value a string[] of that property's values for the company. Holds only the ids the request listed in customPropertyIds; absent when none apply. |
address | Address | The company's primary address. Present only when the request set "includeAddresses": true. |
supportingAddresses | Address[] | Addresses from third-party sources BeCause holds for the company. Present only with "includeAddresses": true; supporting addresses carry no countryName or subdivision fields. |
establishmentTypes | string[] | Establishment type names, for example "Accommodation", "Hotel". Absent when none are set. |
Address
| Field | Type | Notes |
|---|---|---|
latitude | number | |
longitude | number | |
streetAddress | string | |
zipCode | string | |
city | string | |
region | string | |
countryCode | string | ISO 3166-1 alpha-3, for example "DNK". |
countryName | string | |
subdivisionCountryCode | string | ISO 3166-2 subdivision code. |
subdivisionCountryName | string |
Every address field is absent when unknown.
Example
{
"customProperties": [
{ "id": "0992e704-5c3b-4b6e-8a1d-7f2e9c4b6d18", "name": "Partner hotel ID" }
],
"companies": [
{
"id": "9c56d3a1-8b0f-4c7a-9e2d-5b1a7f3e0c11",
"historicalIds": ["1d4f7a2b-6c8e-4b0d-9f3a-5e7c9b1d2f44"],
"name": "Hotel Aurora",
"website": "https://www.hotel-aurora.example",
"fields": {
"0992e704-5c3b-4b6e-8a1d-7f2e9c4b6d18": ["HTL-12345"]
},
"address": {
"latitude": 55.67,
"longitude": 12.56,
"streetAddress": "Harbour Street 1",
"zipCode": "1000",
"city": "Copenhagen",
"countryCode": "DNK",
"countryName": "Denmark"
},
"establishmentTypes": ["Accommodation", "Hotel"]
}
]
}