List custom contact fields
List the workspace's contact fields: key (what field values are stored under), label, kind (text, number, boolean or choice) and, for a choice, its options. A campaign import fills a field from the recipient variable of the same key.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Query Parameters
Items 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/fields"{
"data": [
{
"key": "string",
"label": "string",
"kind": "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
}Import contacts in bulk POST
Add or update up to 5000 contacts by phone number. A number that is already a contact keeps its name unless one is given, gains the new tags and has the given fields set. Each row is checked: a missing or undialable number, a field that doesn't exist or a value that doesn't fit its field is reported in invalid with its row number, and repeated numbers count as duplicates. tags are added to every contact in the import. createMissingFields: true adds a text field for each unknown field key instead of refusing the row. Returns { inserted, updated, duplicates, invalid, createdFields }. Importing never dials anyone.
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.