Get All Consumers

List consumers with pagination, sorting, and optional filters.

Query filters (all optional; combine as needed):

search_term — partial match on name, email, phone, alias, external_id, associated entity name, or associated entity field values

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

pageinteger

Page number, defaults to 1.

limitinteger

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

search_termstring nullable

Free-text search (case-insensitive, partial match). Matches product name and description. Omit to skip text search. Example: ?search_term=premium.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Response

Successful Response