Skip to main content
GET
/
agent
/
{agentId}
cURL
curl --request GET \
  --url https://your-hosted-ip/api/v1/agent/{agentId} \
  --header 'Authorization: <api-key>'
import requests

url = "https://your-hosted-ip/api/v1/agent/{agentId}"

headers = {"Authorization": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://your-hosted-ip/api/v1/agent/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://your-hosted-ip/api/v1/agent/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://your-hosted-ip/api/v1/agent/{agentId}"

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

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://your-hosted-ip/api/v1/agent/{agentId}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://your-hosted-ip/api/v1/agent/{agentId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "url": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "agent": {
    "id": "<string>",
    "accountId": "<string>",
    "workspace": "<string>",
    "statusChanges": [
      {
        "code": "<string>",
        "sub_code": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "joinParams": {
    "agentId": "<string>",
    "agentName": "<string>",
    "meetingId": "<string>",
    "meetingPassword": "<string>",
    "meetingUrl": "<string>",
    "webhookUrl": "<string>",
    "platform": "<string>",
    "metadata": {},
    "automaticLeave": {
      "EveryoneLeftTimeout": 123,
      "NoOneJoinedTimeout": 123,
      "WaitingRoomTimeout": 123
    },
    "adhoc": true
  }
}
{
"error": 123,
"message": "<string>"
}
{
"error": 123,
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Use the format 'Token ' for authentication.

Path Parameters

agentId
string
required

The ID of the agent whose details is being fetched

Response

Agent details successfully fetched for the agent

url
string

URL of the meeting recording

startedAt
string<date-time>

When recording started

completedAt
string<date-time>

When recording completed

agent
object
joinParams
object