List all calls

Updated:

GET/uc/{connection_id}/call

Returns a list of UcCalls. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
user_idstring
The user/employee ID to filter by (reference to HrisEmployee)
contact_idstring
The contact ID to filter by (reference to UcContact)
start_gtestring
The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_ltstring
The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

UcCallarray
idstring
Unique identifier for this call object
created_atdate-time
The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contact_idstring
The contact ID for call (reference to UcContact)
telephoneobject
The telephone number called
start_atdate-time
The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstring
(reference to HrisEmployee)
contacts array
is_privateboolean
user_namestring
user_phonestring
type enum
Valid values:
"INBOUND"
"OUTBOUND"
metadata array
conversation_identifierstring
opaque identifier shared across legs of one interaction
status enum
Valid values:
"QUEUED"
"RINGING"
"IN_PROGRESS"
"COMPLETED"
"BUSY"
The current or final status of the call
answer_atdate-time
When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
duration_secondsnumber
Call length in seconds
cost_amountnumber
What the integration charged for the call
currencystring
ISO 4217 currency of cost_amount
parent_idstring
The parent call (leg) that this call belongs to
instructions array
Write-only: what the call does once answered (create/update only; never returned)

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/uc/5de520f96e439b002043d8dc/call',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-23T15:14:03.477Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    user_id: '',
    contact_id: '',
    start_gte: '',
    end_lt: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?