Sign in
Customers

List customers

List customers.

get/api/v1/customers

Query parameters

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

The order direction.

orderBy'id' | 'name' | 'createdAt'

Order by options for customers.

The order by field.

includeDeletedboolean

Include deleted customers.

keystring

Filter customers by key. Case-insensitive partial match.

namestring

Filter customers by name. Case-insensitive partial match.

primaryEmailstring

Filter customers by primary email. Case-insensitive partial match.

subjectstring

Filter customers by usage attribution subject. Case-insensitive partial match.

planKeystring

Filter customers by the plan key of their susbcription.

expandCustomerExpand[]

What parts of the list output to expand in listings

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Example response

{
  "items": [
    {
      "createdAt": "2024-01-01T01:01:01.001Z",
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "name": "ACME Inc.",
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "usageAttribution": {
        "subjectKeys": [
          "my_subject_key"
        ]
      }
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalCount": 500
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.