Skip to content
Stella ConnectDocs
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.

Authx-api-key

Field
Type
Required
CompanyLocationKeyuuidYes

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
dataobject | nullNo
data.items[]object[]No
data.items[].contactCompanyKeyuuidNo

Unique identifier for the contact company

data.items[].namestringNo

Display name of the contact company

errors[]object[] | nullNo

One or more errors describing why the request failed. Absent (null) on success.

errors[].descriptionstring | nullNo

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[].errorIdstring | nullNo

Machine-readable, stable error identifier. Consumers should branch on this value rather than on Description. See ConnectErrorIds for the catalog.

pagingobject | nullNo

Paging metadata for list endpoints. Absent on single-item responses.

paging.limitintegerNo
paging.startintegerNo
paging.totalintegerNo

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