List contact locations
Returns all locations for a contact company. Pass ContactCompanyLocationKey from these results to ListContacts.
x-api-keyField | Type | Required |
|---|---|---|
| ContactCompanyKey | uuid | Yes |
Status | When |
|---|---|
| 200 | Success |
| 400 | Validation failed or the request was malformed. |
| 401 | Unauthorized |
| 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 this contact company location |
| data. | string | No | Display name for this location |
| data. | boolean | No | Whether this location is exempt from tax calculations |
| data. | uuid | No | Identifier for the payment terms applied to this location |
| data. | uuid | null | No | Identifier for the price tier applied to this location, or null if using default pricing |
| data. | boolean | No | Whether this contact location is linked to a supplier company in Stella |
| data. | object | No | Physical address details 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": {
"items": [
{
"contactCompanyLocationKey": "fc0f0a87-2a40-49cb-9ccc-ca8f9afb1895",
"name": "string",
"isTaxExempt": true,
"paymentTermKey": "397609a9-09e3-43d8-becb-25d341403943",
"priceTierKey": "ef468774-cfd9-4c52-8876-5ff48279511d",
"isLinkedToStellaCompany": true,
"location": {
"addressLine1": "string",
"addressLine2": "string",
"locality": "string",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
}
]
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}