Commerce
List contact companies
GET{baseUrl}/v1.0/commerce/contact-companies/{CompanyLocationKey}
Returns all companies in a location's contacts. Pass ContactCompanyKey from these results to ListContactLocations.
Auth
x-api-keyField | Type | Required |
|---|---|---|
| CompanyLocationKey | 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 the contact company |
| data. | string | No | Display name of the contact company |
| 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 |
Example 200 response
{
"data": {
"items": [
{
"contactCompanyKey": "18251b8d-907e-467d-8eda-175ad24ecfcc",
"name": "string"
}
]
},
"errors": [
{
"description": "string",
"errorId": "string"
}
],
"paging": {
"limit": 0,
"start": 0,
"total": 0
}
}