Skip to content
Stella ConnectDocs
Commerce

List contacts

GET{baseUrl}/v1.0/commerce/contacts/{ContactCompanyLocationKey}

Returns all contacts at a specific contact company location. The ExternalId on each contact reflects any ERP identifier stored via the external ID system.

Authx-api-key

Field
Type
Required
ContactCompanyLocationKeyuuidYes

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[].contactKeyuuidNo

Unique identifier for the contact

data.items[].contactCompanyLocationKeyuuidNo

Identifier for the contact company location this contact belongs to

data.items[].emailAddressstringNo

Email address of the contact

data.items[].firstNamestringNo

First name of the contact

data.items[].lastNamestringNo

Last name of the contact

data.items[].phoneNumberstringNo

Phone number of the contact

data.items[].externalIdstring | nullNo

External ERP identifier for the contact, if set

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": [
      {
        "contactKey": "2e883457-fcb8-4fa5-aa10-aabe744871a0",
        "contactCompanyLocationKey": "fc0f0a87-2a40-49cb-9ccc-ca8f9afb1895",
        "emailAddress": "string",
        "firstName": "string",
        "lastName": "string",
        "phoneNumber": "string",
        "externalId": "string"
      }
    ]
  },
  "errors": [
    {
      "description": "string",
      "errorId": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "start": 0,
    "total": 0
  }
}