Sign in
customers
public

List Customers

List customers.

Scopes: customers:read customers:write

get/v1/customers/

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

emailstring nullable

Filter by exact email.

Filter by exact email.

querystring nullable

Filter by name, email, or external ID.

Filter by name, email, or external ID.

activeboolean nullable

Filter by active customers, i.e. customers with at least one trialing, active or past_due subscription.

Filter by active customers, i.e. customers with at least one trialing, active or past_due subscription.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

sortingCustomerSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

metadataMetadataQuery nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response

itemsCustomer[] required— unresolved $ref

Changes

Changed in 1 of the 11 revisions of this API.2

  • f9688fd328d62See the full diff
    • ○

      added the required property items/items/oneOf[subschema #1: CustomerIndividual]/first_user_event_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/oneOf[subschema #2: CustomerTeam]/first_user_event_at to the response with the 200 status

      response-required-property-added