Get a contact
Read one contact by id or phone number, with its tags, field values and doNotCall.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
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/string"{
"contact": {
"id": "string",
"phoneNumber": "string",
"tags": [
"string"
],
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"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
}Delete a contact DELETE
Delete one contact. Campaign recipients made from it keep their own copy of the name and variables, and what agents remember about the caller is not touched. The number stays on the do-not-call list if it is there. This can't be undone.
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.