Retrieve a call

Updated: November 9, 2026

GET/uc/{connection_id}/call/{id}

Retrieves a single UcCall by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

Returns

UcCall

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this call object
`created_at`	string (date-time)	No	The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`contact_id`	string	No	The contact ID for call (reference to UcContact)
`telephone`	object	No	The telephone number called
`telephone.telephone`	string	Yes
`telephone.type`	enum	No	Values: `WORK`, `HOME`, `OTHER`, `FAX`, `MOBILE`
`start_at`	string (date-time)	No	The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`end_at`	string (date-time)	No	The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`user_id`	string	No	(reference to HrisEmployee)
`contacts`	UcContact[]	No
`contacts[].id`	string	No	Unique identifier for this contact object
`contacts[].created_at`	string (date-time)	No	The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`contacts[].updated_at`	string (date-time)	No	The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`contacts[].name`	string	No	The name of the contact
`contacts[].first_name`	string	No
`contacts[].last_name`	string	No
`contacts[].title`	string	No	The job title of the contact
`contacts[].company`	string	No	The company/organization name of the contact
`contacts[].emails`	UcEmail[]	No	An array of email addresses for this contact
`contacts[].emails[].email`	string	Yes
`contacts[].emails[].type`	enum	No	Values: `WORK`, `HOME`, `OTHER`
`contacts[].telephones`	UcTelephone[]	No	An array of telephones for this contact
`contacts[].telephones[].telephone`	string	Yes
`contacts[].telephones[].type`	enum	No	Values: `WORK`, `HOME`, `OTHER`, `FAX`, `MOBILE`
`contacts[].metadata`	UcMetadata[]	No
`contacts[].metadata[].id`	string	No
`contacts[].metadata[].slug`	string	No
`contacts[].metadata[].value`	object	No
`contacts[].metadata[].namespace`	string	No
`contacts[].metadata[].format`	enum	No	Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `MEASUREMENT`, `PRICE`, `YES_NO`, `CURRENCY`, `URL`
`contacts[].metadata[].extra_data`	object	No
`is_private`	boolean	No
`user_name`	string	No
`user_phone`	string	No
`type`	enum	No	Values: `INBOUND`, `OUTBOUND`
`metadata`	UcMetadata[]	No
`metadata[].id`	string	No
`metadata[].slug`	string	No
`metadata[].value`	object	No
`metadata[].namespace`	string	No
`metadata[].format`	enum	No	Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `MEASUREMENT`, `PRICE`, `YES_NO`, `CURRENCY`, `URL`
`metadata[].extra_data`	object	No
`conversation_identifier`	string	No	opaque identifier shared across legs of one interaction
`status`	enum	No	The current or final status of the call Values: `QUEUED`, `RINGING`, `IN_PROGRESS`, `COMPLETED`, `BUSY`, `NO_ANSWER`, `FAILED`, `CANCELED`, `OTHER`
`answer_at`	string (date-time)	No	When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`duration_seconds`	number	No	Call length in seconds
`cost_amount`	number	No	What the integration charged for the call
`currency`	string	No	ISO 4217 currency of cost_amount
`parent_id`	string	No	The parent call (leg) that this call belongs to
`instructions`	UcCallInstruction[]	No	Write-only: what the call does once answered (create/update only; never returned)
`instructions[].type`	enum	Yes	Values: `SAY`, `PLAY`, `PAUSE`, `DIAL`, `HANGUP`
`instructions[].text`	string	No	SAY: text to speak
`instructions[].language`	string	No	SAY: BCP 47 language code (e.g. en-US), passed to the integration as-is
`instructions[].audio_url`	string	No	PLAY: public MP3 or WAV URL
`instructions[].seconds`	number	No	PAUSE: length of silence
`instructions[].telephone`	UcCallInstruction_telephone	No	DIAL: number to dial and bridge
`instructions[].telephone.telephone`	string	Yes
`instructions[].telephone.type`	enum	No	Values: `WORK`, `HOME`, `OTHER`, `FAX`, `MOBILE`
`instructions[].sip_uri`	string	No	DIAL: SIP address to dial instead of telephone
`instructions[].user_phone`	string	No	DIAL: caller ID on the dialed leg (defaults to the call's user_phone)
`instructions[].timeout_seconds`	number	No	DIAL: how long to ring before giving up

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"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not 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/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.uc.getUcCall({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/uc/5de520f96e439b002043d8dc/call/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/uc/5de520f96e439b002043d8dc/call/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/uc/5de520f96e439b002043d8dc/call/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/uc/5de520f96e439b002043d8dc/call/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/uc/5de520f96e439b002043d8dc/call/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/uc/5de520f96e439b002043d8dc/call/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/uc/5de520f96e439b002043d8dc/call/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?