v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB

Customers

List Customers

Retrieve a list of customers. The list can be filtered, sorted, and paginated using the parameters below.

get/customers

Query parameters

external_idstring

Example:28hs67udfh-213csss-12d31ja

An external_id used to filter the customers.

limitinteger

Example:20

The maximum number of customers returned.

sort_order'asc' | 'desc'

Example:asc

The sort order for the results.

cursorstring

The cursor to return the next page of results.

Response

Success

next_page_urlstring nullable

previous_page_urlstring nullable

Example response

{
  "customers": [
    {
      "id": 9007199254740991,
      "external_id": "71263csss-12uhsdfh-2138dja",
      "sales_channel": "shopify",
      "first_name": "Edgar",
      "last_name": "Martinez",
      "email": "sample@example.com",
      "phone": "678-999-8212",
      "tags": [
        "FirstPurchase",
        "ReturnCustomer"
      ]
    }
  ]
}