Skip to main content
GET
Get an agent

Authorizations

X-Api-Key
string
header
required

Your API key.

Path Parameters

id
string<uuid>
required

Unique identifier of the agent

Response

OK

id
string<uuid>

Unique identifier of the agent

telephonyConfiguration
object

Telephony configuration of the agent containing phone numbers and SIP connections

name
string

Name of the agent

type
enum<string>

Type of the agent

Available options:
INBOUND,
OUTBOUND
active
boolean

If the agent is active

recordable
boolean

If the agent record calls

archived
boolean

If the agent is archived

configuration
object

Configuration of the agent