Get agent
Returns one agent with the same fields as in the list: name, language, phone line, state and the variables declared by the organization. The value of a variable with a fixed value is never returned here: has_default only tells whether it is set (read it with GET /agents/{agent_id}/variables). An agent of another organization, a colleague of a team and an agent that does not exist all give 404. Required scope: agents:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.
Authentication
Path parameters
Id of an agent of the organization, as returned by GET /agents.
Headers
API version for this request; defaults to the version the key is pinned to.
Response
Always agent.
Id of the agent. Use it in the path of the other agent endpoints and as agent_id wherever an agent is asked for.
Name of the agent: the name of the assistant, or the name of the business when the assistant has no name. A default name when neither is set.
Base language of the agent, for example it; multi for a multilingual agent.
active: the agent works normally. suspended: the agent does not answer (callers hear busy), does not call, its web widget does not open and its campaigns are paused. Calls already in progress end normally.
When the agent was suspended; null when it is active.
When the agent was created. null for some older agents.
When the agent was last changed. null when it is not recorded.
Variables declared by the organization for this agent (not the ones the platform always provides).