Skip to main content
GET
Get agent status

Authorizations

X-API-Key
string
header
required

API key for external access. Format: tp_live_<32-hex-chars>. Create keys in the TalkPilot Dashboard under Settings > API.

Path Parameters

agentId
string<uuid>
required

Agent UUID

Response

Agent status

id
string<uuid>
name
string
is_active
boolean
schedule
object | null

Agent business hours. When set, the agent only accepts calls during the specified time windows. Outside hours, calls go to the backup agent.

is_within_schedule
boolean

Whether the agent is currently within scheduled hours