Resource

Contacts

People in your CRM. Stages, tags, owner, custom fields.

Endpoints · 5

Read · GET

Fetch data — accept query filters, return JSON. Read-only and idempotent.

GET
List contacts
/v1/contacts
/v1/contacts
Returns a cursor-paginated list of contacts visible to the API key. Supports filtering by stage, owner, tag, and updated-since.
GET
Retrieve a contact
/v1/contacts/{id}
/v1/contacts/{id}

Create · POST

Create new records. Send a JSON body; the response is the created resource.

POST
Create a contact
/v1/contacts
/v1/contacts
Creates a new contact. Email is the dedupe key — if a contact with the same `email` already exists, the request is idempotently merged onto the existing row (additional emails / phones unioned, blank fields filled).

Update · PATCH

Update existing records with a partial diff. Unsent fields are left untouched.

PATCH
Update a contact
/v1/contacts/{id}
/v1/contacts/{id}
Partial update. Fields not present in the body are left unchanged. To clear a field, send `null` explicitly.

Delete · DELETE

Destructive — removes the record. Requires a *:write scope.

DELETE
Delete a contact
/v1/contacts/{id}
/v1/contacts/{id}
Hard-deletes the contact. Touchpoints, sent emails, calls, and meetings keep their `contact_id` foreign keys with ON DELETE SET NULL.

Object shape

The contacts object

Contacts are the canonical person record. Stages live on `internal_stage`; tags are an array; custom fields are a free-form JSONB map keyed by field id.

Contacts object

{
  "id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
  "email": "ankit@example.com",
  "full_name": "Ankit Bhardwaj",
  "first_name": "Ankit",
  "last_name": "Bhardwaj",
  "title": "Head of Growth",
  "phone": "+919555516408",
  "mobile_phone": null,
  "whatsapp_number": "+919555516408",
  "linkedin_url": "https://www.linkedin.com/in/ankitbhardwaj",
  "organization_id": "9b2e1cd4-3c9b-4a1d-9b2f-21efae55c012",
  "internal_stage": "meeting_booked",
  "owner_id": "b1f2c3d4-5678-90ab-cdef-1234567890ab",
  "tags": [
    "high-intent",
    "warm-intro"
  ],
  "additional_emails": [],
  "additional_phones": [],
  "custom_fields": {
    "region": "APAC",
    "priority_score": 87
  },
  "last_engagement_at": "2026-05-01T14:30:00.000+05:30",
  "created_at": "2026-04-12T09:11:00.000+05:30",
  "updated_at": "2026-05-01T14:30:00.000+05:30"
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.