List Contacts

Retrieve a paginated list of contacts

GET /api/v1/contacts

cURL

curl https://app.demeterrr.com/api/v1/contacts?page=1&limit=50 \
  -H "X-API-Key: dem_your_key_here"

Response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "[phone]",
      "title": "Mr.",
      "preferredLanguage": "en",
      "locationId": "660e8400-e29b-41d4-a716-446655440000",
      "contactOrganizationId": null,
      "customFields": {
        "birthday": "1990-01-15",
        "membershipTier": "Gold"
      },
      "tags": ["vip", "frequent-customer"],
      "unsubscribed": false,
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-02-10T14:20:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "total": 247,
    "totalPages": 5
  }
}

Authentication

Requires contacts:read scope.

Query Parameters

page · integer · default: "1"

Page number to retrieve

limit · integer · default: "50"

Number of items per page (max: 100)

search · string

Search by first name, last name, or email

email · string

Filter by exact email address

phone · string

Filter by phone number

location_id · string

Filter by location UUID

Response

data · array

Show Contact Object

id · string

Unique identifier (UUID)

email · string

Contact’s email address

firstName · string

Contact’s first name

lastName · string

Contact’s last name

phone · string

Contact’s phone number (E.164 format)

title · string

Contact’s job title or salutation

preferredLanguage · string

Preferred language (en or fr)

locationId · string

Associated location UUID

contactOrganizationId · string

Associated organization UUID

customFields · object

Custom field values (key-value pairs)

tags · array

Array of tag strings

unsubscribed · boolean

Whether contact has unsubscribed

createdAt · string

ISO 8601 timestamp

updatedAt · string

ISO 8601 timestamp

meta · object

Show Pagination Meta

page · integer

Current page number

perPage · integer

Items per page

total · integer

Total number of contacts

totalPages · integer

Total number of pages

cURL

curl https://app.demeterrr.com/api/v1/contacts?page=1&limit=50 \
  -H "X-API-Key: dem_your_key_here"

Response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "[phone]",
      "title": "Mr.",
      "preferredLanguage": "en",
      "locationId": "660e8400-e29b-41d4-a716-446655440000",
      "contactOrganizationId": null,
      "customFields": {
        "birthday": "1990-01-15",
        "membershipTier": "Gold"
      },
      "tags": ["vip", "frequent-customer"],
      "unsubscribed": false,
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-02-10T14:20:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 50,
    "total": 247,
    "totalPages": 5
  }
}