Agents
Methods allow you to get a list of portal agents or information on a specific agent.
GET /agents
Return a list of agents.
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|
Response parameters
count integer
The number of agents.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about agents.
- id integer Agent ID.
- name string [ 1 .. 255 ] characters Agent name.
- route string <= 255 characters Nullable Agent route.
- agent_role string <= 255 characters Agent role.
GET /agents/{id}
Return information about the agent by ID.
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|
Response parameters
id integer
Agent ID.
name string [ 1 .. 255 ] characters
Agent name.
route string <= 255 characters Nullable
Agent route.
agent_role string <= 255 characters
Agent role.