Sign in
Customers API

List customers

Retrieve a list of all customers.

The results are paginated.

get/v2/customers

Query parameters

fromstring
Example:cst_5B8cwPMGnU

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

sort'asc' | 'desc'
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of customer objects.

Changes

Changed in 7 of the 79 revisions of this API.174

  • 86a9cd830b062See the full diff
    • ●

      added the new en_BE enum value to the /////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new en_NL enum value to the /////// response property for the response status

      response-property-enum-value-added

  • 64c0511a62bc11See the full diff
    • ●

      added the new undefined enum value to the /////// response property for the response status

      response-property-enum-value-added

    • ○

      removed the null enum value from the /////// response property for the response status

      response-property-enum-value-removed

  • 4d4ab81fb2d52See the full diff
    • ●

      added the new cs_CZ enum value to the /////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sk_SK enum value to the /////// response property for the response status

      response-property-enum-value-added

  • 1bcb76dbe9ea1See the full diff
    • ▲

      the response property's min was decreased from 1.00 to 0.00 for the response status

      response-property-min-decreased

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f3d6346a14122See the full diff
    • ●

      added the new de_LU enum value to the /////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new fr_LU enum value to the /////// response property for the response status

      response-property-enum-value-added

Of the 79 revisions, 9 have no diff computed.