Skip to main content
GET
/
commerce
/
customer
/
accounts
/
{accountId}
/
contacts
/
{contactId}
Error
A valid request URL is required to generate request examples
{
  "accountId": 123,
  "types": [
    {
      "name": "<string>",
      "isPrimary": true
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "faxNumber": "<string>",
  "label": "<string>",
  "id": 123,
  "email": "<string>",
  "firstName": "<string>",
  "middleNameOrInitial": "<string>",
  "lastNameOrSurname": "<string>",
  "companyOrOrganization": "<string>",
  "phoneNumbers": {
    "home": "<string>",
    "mobile": "<string>",
    "work": "<string>"
  },
  "address": {
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "address4": "<string>",
    "cityOrTown": "<string>",
    "stateOrProvince": "<string>",
    "postalOrZipCode": "<string>",
    "countryCode": "<string>",
    "addressType": "<string>",
    "isValidated": true
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
accountId
integer<int32>
required

Unique identifier of the customer account whose CustomerContact information you want to retrieve.

​
contactId
integer<int32>
required

Unique identifier of the CustomerContact whose details you want to retrieve.

Query Parameters

​
userId
string

If provided, the primary markings on the contact will be based on the user's preferred primary overrides

​
responseFields
string

limits which fields are returned in the response body

Response

Success

CustomerContact information for a customer account including the name, company, phone numbers, email addresses, and billing and shipping addresses (if supplied).

​
accountId
integer<int32>
​
types
object[] | null
​
auditInfo
object
​
faxNumber
string | null
​
label
string | null
​
id
integer<int32> | null
​
email
string | null
​
firstName
string | null
​
middleNameOrInitial
string | null
​
lastNameOrSurname
string | null
​
companyOrOrganization
string | null
​
phoneNumbers
object
​
address
object