List contacts

GET

/v1/contacts

const url = 'https://api.vocapable.com/v1/contacts?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.vocapable.com/v1/contacts?limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Parameters

Query Parameters

limit

Limit

integer

default: 50 >= 1 <= 200

cursor

Any of:

string
null

string

best_consent_class

Any of:

string
null

string

Filter on best_consent_class. Comma-separated values are OR.

best_consent_class.gte

Any of:

string
null

string

Filter on best_consent_class with the gte operator.

best_consent_class.lte

Any of:

string
null

string

Filter on best_consent_class with the lte operator.

best_consent_class.gt

Any of:

string
null

string

Filter on best_consent_class with the gt operator.

best_consent_class.lt

Any of:

string
null

string

Filter on best_consent_class with the lt operator.

best_consent_class.in

Any of:

string
null

string

Filter on best_consent_class with the in operator.

company

Any of:

string
null

string

Filter on company. Comma-separated values are OR.

company.gte

Any of:

string
null

string

Filter on company with the gte operator.

company.lte

Any of:

string
null

string

Filter on company with the lte operator.

company.gt

Any of:

string
null

string

Filter on company with the gt operator.

company.lt

Any of:

string
null

string

Filter on company with the lt operator.

company.in

Any of:

string
null

string

Filter on company with the in operator.

contact_list_id

Any of:

string
null

string

Filter on contact_list_id. Comma-separated values are OR.

contact_list_id.gte

Any of:

string
null

string

Filter on contact_list_id with the gte operator.

contact_list_id.lte

Any of:

string
null

string

Filter on contact_list_id with the lte operator.

contact_list_id.gt

Any of:

string
null

string

Filter on contact_list_id with the gt operator.

contact_list_id.lt

Any of:

string
null

string

Filter on contact_list_id with the lt operator.

contact_list_id.in

Any of:

string
null

string

Filter on contact_list_id with the in operator.

created_at

Any of:

string
null

string

Filter on created_at. Comma-separated values are OR.

created_at.gte

Any of:

string
null

string

Filter on created_at with the gte operator.

created_at.lte

Any of:

string
null

string

Filter on created_at with the lte operator.

created_at.gt

Any of:

string
null

string

Filter on created_at with the gt operator.

created_at.lt

Any of:

string
null

string

Filter on created_at with the lt operator.

created_at.in

Any of:

string
null

string

Filter on created_at with the in operator.

do_not_call

Any of:

string
null

string

Filter on do_not_call. Comma-separated values are OR.

do_not_call.gte

Any of:

string
null

string

Filter on do_not_call with the gte operator.

do_not_call.lte

Any of:

string
null

string

Filter on do_not_call with the lte operator.

do_not_call.gt

Any of:

string
null

string

Filter on do_not_call with the gt operator.

do_not_call.lt

Any of:

string
null

string

Filter on do_not_call with the lt operator.

do_not_call.in

Any of:

string
null

string

Filter on do_not_call with the in operator.

lead_status

Any of:

string
null

string

Filter on lead_status. Comma-separated values are OR.

lead_status.gte

Any of:

string
null

string

Filter on lead_status with the gte operator.

lead_status.lte

Any of:

string
null

string

Filter on lead_status with the lte operator.

lead_status.gt

Any of:

string
null

string

Filter on lead_status with the gt operator.

lead_status.lt

Any of:

string
null

string

Filter on lead_status with the lt operator.

lead_status.in

Any of:

string
null

string

Filter on lead_status with the in operator.

owner_user_id

Any of:

string
null

string

Filter on owner_user_id. Comma-separated values are OR.

owner_user_id.gte

Any of:

string
null

string

Filter on owner_user_id with the gte operator.

owner_user_id.lte

Any of:

string
null

string

Filter on owner_user_id with the lte operator.

owner_user_id.gt

Any of:

string
null

string

Filter on owner_user_id with the gt operator.

owner_user_id.lt

Any of:

string
null

string

Filter on owner_user_id with the lt operator.

owner_user_id.in

Any of:

string
null

string

Filter on owner_user_id with the in operator.

phone_e164

Any of:

string
null

string

Filter on phone_e164. Comma-separated values are OR.

phone_e164.gte

Any of:

string
null

string

Filter on phone_e164 with the gte operator.

phone_e164.lte

Any of:

string
null

string

Filter on phone_e164 with the lte operator.

phone_e164.gt

Any of:

string
null

string

Filter on phone_e164 with the gt operator.

phone_e164.lt

Any of:

string
null

string

Filter on phone_e164 with the lt operator.

phone_e164.in

Any of:

string
null

string

Filter on phone_e164 with the in operator.

Any of:

string
null

string

Filter on q. Comma-separated values are OR.

q.gte

Any of:

string
null

string

Filter on q with the gte operator.

q.lte

Any of:

string
null

string

Filter on q with the lte operator.

q.gt

Any of:

string
null

string

Filter on q with the gt operator.

q.lt

Any of:

string
null

string

Filter on q with the lt operator.

q.in

Any of:

string
null

string

Filter on q with the in operator.

tag

Any of:

string
null

string

Filter on tag. Comma-separated values are OR.

tag.gte

Any of:

string
null

string

Filter on tag with the gte operator.

tag.lte

Any of:

string
null

string

Filter on tag with the lte operator.

tag.gt

Any of:

string
null

string

Filter on tag with the gt operator.

tag.lt

Any of:

string
null

string

Filter on tag with the lt operator.

tag.in

Any of:

string
null

string

Filter on tag with the in operator.

timezone

Any of:

string
null

string

Filter on timezone. Comma-separated values are OR.

timezone.gte

Any of:

string
null

string

Filter on timezone with the gte operator.

timezone.lte

Any of:

string
null

string

Filter on timezone with the lte operator.

timezone.gt

Any of:

string
null

string

Filter on timezone with the gt operator.

timezone.lt

Any of:

string
null

string

Filter on timezone with the lt operator.

timezone.in

Any of:

string
null

string

Filter on timezone with the in operator.

updated_at

Any of:

string
null

string

Filter on updated_at. Comma-separated values are OR.

updated_at.gte

Any of:

string
null

string

Filter on updated_at with the gte operator.

updated_at.lte

Any of:

string
null

string

Filter on updated_at with the lte operator.

updated_at.gt

Any of:

string
null

string

Filter on updated_at with the gt operator.

updated_at.lt

Any of:

string
null

string

Filter on updated_at with the lt operator.

updated_at.in

Any of:

string
null

string

Filter on updated_at with the in operator.

Responses

200

Successful Response

application/json

CursorPage[ContactSummary]

object

data

required

Data

Array<object>

ContactSummary

A contact as a list endpoint returns it.

object

required

string

phone_e164

required

Phone E164

string

first_name

Any of:

string
null

string

last_name

Any of:

string
null

string

company

Any of:

string
null

string

title

Any of:

string
null

string

email

Any of:

string
null

string

timezone

Any of:

string
null

string

best_consent_class

Any of:

ConsentBasis
null

ConsentBasis

CANON fact 18 - the four consent classes (docs/07-compliance.md §consent).

string

Allowed values: pewc pec ebr transactional

do_not_call

Do Not Call

boolean

lead_status

Any of:

LeadStatus
null

LeadStatus

Where the tenant’s own pipeline holds a contact (migration 0035).

Durable per-contact intent, deliberately separate from Disposition, which is pinned (CANON fact 28) and answers “what happened to the dial” rather than “is this person interested”. A contact is dialed many times and disposed once per attempt; the lead status is the one value that survives across those attempts.

It carries NO compliance meaning whatsoever: LOST is not a suppression, and marking a contact WON neither grants nor implies consent. Suppression is dnc_entries and consent is consent_records - both have their own writers, and neither reads this column.

string

Allowed values: new working qualified unqualified won lost

owner_user_id

Any of:

string
null

string

tags

Tags

Array<string>

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

next_cursor

Any of:

string
null

string

has_more

Has More

boolean

Example

{
  "data": [
    {
      "best_consent_class": "pewc",
      "do_not_call": false,
      "lead_status": "new"
    }
  ],
  "has_more": false
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

List contacts

Authorizations

Parameters

Query Parameters

Responses

200

Example

422

Examplegenerated

Example^generated