List contacts
List a workspace's contacts, 50 a page, most recently changed first. Each has its id, phoneNumber (E.164), name, tags, fields (values by field key), source (import, api or manual), doNotCall (true when the number is on the workspace's do-not-call list, which every campaign skips) and timestamps. search matches part of a name or number; tags keeps contacts with every tag given; fields keeps contacts whose field equals the value given. Contacts are separate from caller memory: someone who has called an agent is a contact only once added.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Query Parameters
Part of a name or phone number.
Only contacts that have every one of these tags.
items <= 50Only contacts whose field (by key) equals this value.
Page number from 1.
1 <= value <= 9007199254740991Contacts a page, default 50.
1 <= value <= 200Items per page, 1 to 200. Default 50.
1 <= value <= 200The next_cursor of the previous page.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/workspaces/string/contacts"{
"data": [
{
"id": "string",
"phoneNumber": "string",
"tags": [
"string"
],
"property1": null,
"property2": null
}
],
"has_more": true,
"next_cursor": "string"
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}List the tags in use, with counts GET
List the tags in use on the workspace's contacts, each with how many contacts carry it ({ tag, count }). Tag or untag contacts with tag_contacts.
Create or change a custom contact field POST
Add a contact field, or change an existing field's label or choice options, by key. key is lowercase letters, digits and underscores, starting with a letter; left out, it is made from the label. kind is text (the default), number, boolean or choice; a choice needs options. A field's kind can't change once it exists (kind_locked): delete it and add a new one. A workspace has at most 50 fields.