Skip to main content
POST
Get agent information

Get Agents

Retrieves detailed information about a specific agent.

Request

Method: POST
Endpoint: /api/get-agent
Headers:
  • X-Authorization: Your API key (required)
  • Content-Type: application/json
Request Body:
Parameters:
  • uid (string, required): Your user ID
  • agentId (string, required): The ID of the agent to retrieve

Response

Success Response (200):
Error Responses:
  • 400 Bad Request: Invalid request body
  • 401 Unauthorized: Invalid or missing API key, or insufficient permissions
  • 500 Internal Server Error: Server error

Example

Authorizations

X-Authorization
string
header
required

Body

application/json
uid
string
required

User ID

agentId
string
required

Agent ID

Response

Successful response

uid
string

User ID

agentId
string

Agent ID

name
string

Agent name

country
string | null

Country code

businessPhoneNumber
string | null

Business phone number

Last modified on July 11, 2026