Customers

List customers

Returns a list of customers for the current account

get/customers

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/customers
  • Auth: API key in header Authorization

Query parameters

customer_type'lead' | 'free' | 'paid'

Filter by customer type

querystring

Search by email or name

deletedboolean

When true, lists deleted customers that have not been permanently erased yet. Each has deleted_at and purge_at.

starting_afterstring

Cursor for pagination — the ID of the last item in the previous page

limitinteger

Items per page

metadataobject

Filter by caller-owned metadata key/value pairs, e.g. metadata[campaign]=spring. Repeatable (up to 10 keys); all pairs must match.

Response

List of customers

object'list' required
has_moreboolean required
urlstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.