API
Data API
Agents
Methods allow you to get a list of portal agents or information on a specific agent.
Return a list of agents.
GET /agents
GET
Request
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format.
Body Parameters
limit
Integer
optional
The number of results to return per page.
offset
Integer
optional
The initial index from which to return the results.
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.
Return information about the agent by ID.
GET /agents/{id}
GET
Request
Path Params
id
String
required
Agent ID.
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format.
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.