Skip to main content
GET
/
customers
{
  "items": [
    {
      "customerId": "<string>",
      "customerType": "CONSUMER",
      "name": "<string>",
      "identity": "<string>",
      "preferredLocale": "en-US",
      "humanReadableId": "29A-BY3Z-X78",
      "contact": {
        "email": "jsmith@example.com",
        "msisdn": "<string>"
      },
      "billing": {
        "method": "EMAIL_INVOICE",
        "email": "billing@company.com",
        "address": {
          "street1": "500 S Main St",
          "street2": "Apt 1",
          "city": "Natick",
          "zip": "01701",
          "country": "US",
          "state": "CA",
          "region": "<string>",
          "attention": "<string>"
        },
        "currency": "USD",
        "defaultPaymentProfileId": "c1d2e3f4-a5b6-7890-1234-901234567890",
        "autoPay": true
      },
      "users": [
        {
          "userId": "<string>",
          "name": "<string>",
          "role": "MEMBER"
        }
      ],
      "contactPersonUserId": "<string>",
      "contactPerson": {
        "userId": "<string>",
        "name": "<string>",
        "role": "MEMBER"
      },
      "shipping": {
        "name": "John Doe",
        "msisdn": "+15551234567",
        "address": {
          "street1": "500 S Main St",
          "street2": "Apt 1",
          "city": "Natick",
          "zip": "01701",
          "country": "US",
          "state": "CA",
          "region": "<string>",
          "attention": "<string>"
        },
        "instructions": "Leave at front door"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "sort": {
      "key": "<string>",
      "direction": "ASC"
    }
  }
}

Authorizations

X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

filter
string

A free text search string to filter customers.

limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0

Response

A list of customers.

items
object[]
pagination
object
I