Sign in
Customers

List customers

Changed on
get/v1/customers

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/customers
  • Auth: HTTP bearer

Query parameters

statusstring
external_idstring

Exact-match filter on the caller-assigned external ID.

idsstring

Comma-separated customer IDs to fetch exactly.

searchstring

Case-insensitive substring match on display name, email, external ID, or ID. Matching runs post-decryption (PII columns are encrypted at rest), bounded to the first 5000 rows of the tenant's filtered set.

sortstring

One of display_name, email, external_id, status, created_at (default).

dir'asc' | 'desc'
limitinteger
offsetinteger

Response

Customer list

Changes

  • 52fa9dd97d08Revision changes
    • info

      added the new optional query request parameter dir

    • info

      added the new optional query request parameter external_id

    • info

      added the new optional query request parameter ids

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sort