List Contacts
Contacts are the people your workspace interacts with. A contact can be linked to platform identities (channels) and carry custom field values. Contacts can be scoped to a profile.
The contact object
{
"id": "con_7hN...",
"profile_id": "pro_9aB...",
"name": "Jane Doe",
"email": "jane@example.com",
"company": "Acme",
"tags": ["vip"],
"notes": "Met at conference",
"subscribed": true,
"blocked": false,
"created_at": "2026-07-12T10:00:00.000Z",
"updated_at": "2026-07-12T10:00:00.000Z"
}
GET
/v1/contactsFilter with ?profile_id=, ?search= (name or email), or ?tag=.
{
"contacts": [
{
"id": "con_7hN...",
"profile_id": "pro_9aB...",
"name": "Jane Doe",
"email": "jane@example.com",
"company": "Acme",
"tags": [
"vip"
],
"notes": "Met at conference",
"subscribed": true,
"blocked": false,
"created_at": "2026-07-12T10:00:00.000Z",
"updated_at": "2026-07-12T10:00:00.000Z"
}
]
} Create Contact
POST
/v1/contactsBody parameters
| Field | Type | Notes |
|---|---|---|
name | string | Required |
profile_id | string | Optional |
email, company, notes | string | Optional |
tags | array | Optional |
platform + platform_identifier | string | Optionally attach a channel |
{
"contact": {
"id": "con_7hN...",
"profile_id": "pro_9aB...",
"name": "Jane Doe",
"email": "jane@example.com",
"company": "Acme",
"tags": [
"vip"
],
"notes": "Met at conference",
"subscribed": true,
"blocked": false,
"created_at": "2026-07-12T10:00:00.000Z",
"updated_at": "2026-07-12T10:00:00.000Z"
}
} Get Contact
GET
/v1/contacts/:idIncludes custom field values.
{
"contact": {
"id": "con_7hN...",
"profile_id": "pro_9aB...",
"name": "Jane Doe",
"email": "jane@example.com",
"company": "Acme",
"tags": [
"vip"
],
"notes": "Met at conference",
"subscribed": true,
"blocked": false,
"created_at": "2026-07-12T10:00:00.000Z",
"updated_at": "2026-07-12T10:00:00.000Z"
}
} Update Contact
PATCH
/v1/contacts/:id{
"contact": {
"id": "con_7hN...",
"profile_id": "pro_9aB...",
"name": "Jane Doe",
"email": "jane@example.com",
"company": "Acme",
"tags": [
"vip"
],
"notes": "Met at conference",
"subscribed": true,
"blocked": false,
"created_at": "2026-07-12T10:00:00.000Z",
"updated_at": "2026-07-12T10:00:00.000Z"
}
} Delete Contact
DELETE
/v1/contacts/:id{ "ok": true } List Channels
GET
/v1/contacts/:id/channels{ "channels": [ { "id": "ch_...", "platform": "instagram", "external_id": "178...", "display": "@jane" } ] } Set Custom Field
PUT
/v1/contacts/:id/fields/:slugSet a custom field value by its slug.
{ "ok": true }