List customers

Returns customers ordered newest-first. Pass external_system + external_id together to look up a single customer by an external ID instead of listing.

GET /v1/customers

Bearer token

curl 'https://api.sendapropos.com/v1/customers?limit=1&cursor=example&external_system=example&external_id=external_01JXY9AZK4KV' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-42d3-a456-426614174000",
      "displayName": "example",
      "email": "[email protected]",
      "companyName": "example",
      "phone": "example",
      "status": "contact",
      "createdAt": "2026-01-01T12:00:00Z",
      "updatedAt": "2026-01-01T12:00:00Z"
    }
  ],
  "nextCursor": "example"
}

A page of customers.

Query parameters

· 4

limit integer · min: 1· max: 100

Page size, 1-100. Defaults to 25.

cursor string

Opaque pagination cursor from a previous response's nextCursor.

external_system string

Name of the external system owning external_id (e.g. zapier, quickbase). Must be paired with external_id.

external_id string

The record ID from the external system. Must be paired with external_system.

Query parameters

Responses