Skip to main content
GET
/
consumers
List consumers
curl --request GET \
  --url https://vvdufluovypptsnkihyv.supabase.co/functions/v1/consumers \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "middle_name": "<string>",
      "date_of_birth": "2023-12-25",
      "phone": "<string>",
      "email": "<string>",
      "address": {
        "street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "US"
      },
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

x-api-key
string
header
required

API key in the format sk_live_<token> (production) or sk_test_<token> (sandbox). Contact Cove to obtain your API key.

Query Parameters

email
string<email>

Filter by exact email match

external_id
string

Filter by exact external_id match

phone
string

Filter by exact phone match (E.164 format)

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
per_page
integer
default:20

Number of records per page

Required range: 1 <= x <= 100

Response

Paginated list of consumers

data
object[]
pagination
object