Sidebar Navigation

API V1 Documentation

General

List contacts (paginated)

Create a contact

Get a contact by identifier

Update a contact

Delete a contact

Call Center

Agents

Agent activity events

Agent availability details

Agent availability metrics

Agent call disposition details

Agent call disposition metrics

Agent pause details

Agent pause metrics

Agent session summary metrics

Answered

Answered calls by agent detailed calls

Answered calls by agent metrics

Answered calls by call duration detailed calls

Answered calls by call duration metrics

Answered calls by disconnection cause detailed calls

Answered calls by disconnection cause metrics

Answered calls by queue detailed calls

Answered calls by queue metrics

Answered detailed calls

Answered service level detailed calls

Answered service level metrics

Answered summary metrics

Distribution

Distribution by DID detailed calls

Distribution by DID metrics

Distribution by queue detailed calls

Distribution by queue metrics

Distribution by time period detailed calls

Distribution by time period metrics

Distribution detailed calls

Distribution summary metrics

Outbound

Outbound calls by disconnection cause detailed calls

Outbound calls by disconnection cause metrics

Outbound calls by time period detailed calls

Outbound calls by time period metrics

Outbound detailed calls

Outbound dialed calls by agent detailed calls

Outbound dialed calls by agent metrics

Outbound summary metrics

Outbound unanswered detailed calls

Search

Search report calls

Settings

List available agents

List available queues

List available queues with agents

Summary

Today per-agent summary metrics

Today workspace summary metrics

Today per-queue summary metrics

Unanswered

Unanswered calls by disconnection cause detailed calls

Unanswered calls by disconnection cause metrics

Unanswered calls by queue detailed calls

Unanswered calls by queue metrics

Unanswered detailed calls

Unanswered service level detailed calls

Unanswered service level metrics

Unanswered summary metrics

Home / API V1 Documentation

List contacts (paginated)

GET/v1/contacts

Returns non-blocked contacts, ordered by `created_at` descending. Blocked contacts are excluded from this list but can still be retrieved by identifier. Empty results return `200` with `data: []` and `meta.total: 0`.