List company locations
Returns all active locations. Use the returned Key values as CompanyLocationKey path parameters in downstream contact and product endpoints.
x-api-keyStatus | When |
|---|---|
| 200 | Success |
| 400 | Validation failed or the request was malformed. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | An unexpected error occurred on the server. |
Field | Type | Required | Description |
|---|---|---|---|
| data | object | null | No | |
| data. | object[] | No | |
| data. | uuid | No | Unique identifier for the company location |
| data. | string | No | Display name of the location |
| data. | string | No | Short alias or code for the location |
| data. | boolean | No | Whether this is the primary location for the company |
| data. | string | No | Phone number for this location |
| data. | string | No | Street address line 1 |
| data. | string | null | No | Street address line 2, if provided |
| data. | string | No | City or locality |
| data. | string | No | State or province |
| data. | string | No | Postal or ZIP code |
| data. | string | No | Country code |
| errors[] | object[] | null | No | One or more errors describing why the request failed. Absent ( |
| errors[]. | string | null | No | Human-readable explanation of the error. Intended for display to end users or logs. Wording is not stable and should not be branched on. |
| errors[]. | string | null | No | Machine-readable, stable error identifier. Consumers should branch on this value
rather than on Description. See |
| paging | object | null | No | Paging metadata for list endpoints. Absent on single-item responses. |
| paging. | integer | No | |
| paging. | integer | No | |
| paging. | integer | No |
{
"data": {
"locations": [
{
"key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
"name": "string",
"alias": "string",
"isPrimary": true,
"phoneNumber": "string",
"addressLine1": "string",
"addressLine2": "string",
"locality": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
]
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}