Skip to main content

Get All Consumers

GET 
/api/v2/consumers

List consumers with pagination, sorting, and optional filters.

Query filters (all optional; combine as needed):

  • search_term — partial match on name, email, phone number, alias, or external_id

External metadata filters (optional, combine with other filters):

  • Use any external metadata key you stored on create/update as a query parameter: external_metadata.<key>=<value>
  • Exact match, case-sensitive. Multiple keys are ANDed.
  • Example: if a consumer was created with "external_metadata": {"segment": "enterprise", "tier": "gold"}, filter with ?external_metadata.segment=enterprise&external_metadata.tier=gold

Pagination: page (default 1), limit (default 10, max 100)

Sorting: sort_field (name, created_at, email, phone_number, external_id; default created_at), sort_direction (asc or desc; default desc)

Example: /api/v2/consumers?search_term=Acme&external_metadata.segment=enterprise&page=1&limit=20

Request​

Responses​

Successful Response