v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Customer Aliases

List all Customer Aliases

get/customer-aliases

Query parameters

valuestring

Filter customer aliases by value

limitinteger

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

afterstring

Pagination offset. 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.

beforestring

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

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

Example response

{
  "items": [
    {
      "id": "01849e70-0a0f-72ca-ba07-5557dd734d43",
      "sequenceAccountId": "ec1479a2-6ba1-421f-a7de-0853a20d17a1",
      "customerId": "01849e70-703e-705a-b59a-d3fd575587e0",
      "value": "external-customer-alias-123",
      "createdAt": "2022-10-01T00:00:00Z",
      "deletedAt": "2022-10-01T00:00:00Z",
      "label": "CRM ID",
      "archivedAt": "2022-10-01T00:00:00Z"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}