Retrieve specific API Call by its ID

GET/unified/apicall/{id}

Parameters

idstring required

ID of the Apicall

Returns

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this API call (read-only)
`created_at`	string (date-time)	No	The date that this object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
`connection_id`	string	No
`workspace_id`	string	No	(reference to KmsSpace) (read-only)
`integration_type`	string	Yes	The integration type
`external_xref`	string	No	your customer's user ID
`name`	string	Yes	The called name of the API method
`path`	string	Yes	The called API method's HTTP verb and route path (PUT /crm/{integration}/deak/{id})
`size`	number	No	The size of the response
`status`	string	Yes	The resulting HTTP status code (200)
`error`	string	No	The error description (if status code is >= 400)
`ip_address`	string	No
`type`	enum	Yes	The type of API Call being logged Values: `login`, `webhook`, `inbound`, `mcp`
`method`	string	Yes
`environment`	string	No
`webhook_id`	string	No
`is_billable`	boolean	No
`user_agent`	string	No
`unified_response_time`	number	No
`endapi_response_time`	number	No

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/unified/apicall/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },

};

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 id = '1234';

const results = await sdk.unified.getUnifiedApicall({ id: '5dc201f9414446e39b2045aa', 

 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/unified/apicall/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },

};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/unified/apicall/5de520f96e439b002043d8d8")
  .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/unified/apicall/5de520f96e439b002043d8d8

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/unified/apicall/5de520f96e439b002043d8d8"

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/unified/apicall/5de520f96e439b002043d8d8",
  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/unified/apicall/5de520f96e439b002043d8d8")

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/unified/apicall/5de520f96e439b002043d8d8' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?