GET
/
customers
curl --request GET \
  --url https://eu.sequencehq.com/api/customers \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "address": {
        "country": "GB",
        "line1": "Flat 1",
        "line2": "123 Fake Street",
        "postcode": "AB1 2EF",
        "town": "London"
      },
      "archivedAt": "2022-06-28T16:47:00Z",
      "billingEmails": [
        "exampleCorpInvoices@example.com"
      ],
      "contactName": "John Doe",
      "createdAt": "2022-06-28T16:47:00Z",
      "email": "john@example.com",
      "externalIds": [
        {
          "key": "Xero",
          "syncTime": "2022-06-28T16:47:00Z",
          "value": "ID"
        },
        {
          "key": "Stripe",
          "syncTime": "2022-06-28T16:47:00Z",
          "value": "cus_OCtCxqQDgu1uX9"
        }
      ],
      "id": "e309e948-088e-4d77-b654-cd85498f1555",
      "label": "Example customer",
      "legalName": "John Doe",
      "sequenceAccountId": "25b3c342-6fa6-4375-9ed3-616f05abb77a",
      "taxStatus": "TAXED",
      "telephone": "02010001000",
      "url": "https://example.com/"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Query Parameters

sortBy
string

Sort column. Default: creation time.

legalName
string

Filter by legal name

email
string

Filter by email

alias
string

Filter by alias

includeArchived
boolean

Include archived customers

before
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

after
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

limit
integer

Maximum number of objects to return per-page.

sortOrder
string

Sort order. Default: DESC (descending, most often used for reverse chronological sorting).

Response

200 - application/json
items
object[]
required

Customers

pagination
object
required