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.
Request example
GET /agents
GET
https://instance_name/api/data/v1.0/agents/
curl –i –X GET
https://test.eyrene.com/api/data/v1.0/agents/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
–F "limit=3" \
–F "offset=0" 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.
Request example
GET /agents/{id}
GET
https://instance_name/api/data/v1.0/agents/{id}
curl –i –X GET
https://test.eyrene.com/api/data/v1.0/agents/19765/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
–F "limit=3" \
–F "offset=0" 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.