v1

latestOpenAPI 3.1.02026-07-263788129.7 KB

Contacts

List Contacts

Returns a paginated list of contacts.

post/v1/contacts/list

Request body

pageinteger

Page number (1-indexed)

page_sizeinteger

Number of results per page

sortstring

Field to sort by. Prefix with '-' for descending order.

include_custom_fieldsboolean

Whether to include custom fields (custom_field_<uuid> keys) on each returned contact. Defaults to true. Set false to omit them for leaner responses; GET /v1/contacts/{contact_id} always returns them.

Response

Successful Response

Example response

{
  "data": [
    {
      "id": "con_abc123",
      "account_id": "acc_def456",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "jane@acme.com",
      "title": "VP of Engineering",
      "phone_number": "+1-555-123-4567",
      "linkedin_url": "https://linkedin.com/in/janesmith",
      "location": "San Francisco, CA",
      "source": "linkedin",
      "notes": "Met at SaaStr 2025",
      "scoring": {
        "heat_score": "Hot"
      },
      "tags": [
        "Interested",
        "Decision Maker"
      ],
      "created_at": "2025-06-15T10:30:00Z",
      "updated_at": "2025-06-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 25,
    "total_count": 142,
    "total_pages": 6
  }
}