Retrieve a Customer

Retrieve a Customer Account. This retrieve’s the Customer’s profile information.

Endpoint

GET /v1/customers/{customerId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

customerId

string (UUID)

Customer ID.

Request Body

None

Returns

Returns the Customer Account details. For details, see the Business Customer and Individual Customer objects.

SAMPLE RESPONSE

				
					{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "ACTIVE",
  "addresses": [
    {
      "type": "MAILING",
      "addressLine1": "100 Main St",
      "addressLine2": "Suite 100",
      "addressLine3": "",
      "addressLine4": "",
      "addressLine5": "",
      "cityName": "Greenville",
      "stateCode": "MO",
      "countryCode": "USA",
      "zipCode": "63368"
    },
    {
      "type": "SHIPPING",
      "addressLine1": "200 King St",
      "addressLine2": "Suite 310",
      "addressLine3": "",
      "addressLine4": "",
      "addressLine5": "",
      "cityName": "Greenville",
      "stateCode": "MO",
      "countryCode": "USA",
      "zipCode": "63368"
    }
  ],
  "shippingContact": {
    "shipToFirstName": "Jack",
    "shipToMiddleName": "Fred",
    "shipToLastName": "Smith"
  },
  "metadata": {
    "customerRefId": "100000333"
  },
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  },
  "createdAt": "2022-11-23T00:42:50.311Z",
  "updatedBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  },
  "updatedAt": "2022-11-23T00:42:50.311Z",
  "type": "BUSINESS",
  "doingBusinessAsName": "ACME Corp.",
  "contacts": [
    {
      "firstName": "Jack",
      "middleName": "Fred",
      "lastName": "Smith",
      "primary": true,
      "primaryPhoneNumber": {
        "number": "+14151234",
        "type": "WORK",
        "provider": "ABC",
        "extension": "675",
        "verified": false
      },
      "primaryEmail": {
        "value": "jsmith@acme.com",
        "verified": false
      }
    }
  ]
}