Skip to main content

GET /agents

Returns a list of agents.

Address: GET https://instance_name/api/data/v1.3/agents/

Content-type: application/json

Request body parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

Request example

curl –i –X GET
  https://test.inspector-cloud.com/api/data/v1.3/agents/ 
  -H ‘Authorization: Token <<your_token>>’ 
  –F "limit=3" \
  –F "offset=0"

Response example

Response code: 200

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 23679,
      "name": "Alex",
      "route": "163968",
      "agent_role": null
    },
    {
      "id": 36777,
      "name": "",
      "route": "283140",
      "agent_role": null
    },
    {
      "id": 32410,
      "name": "John",
      "route": "154039",
      "agent_role": null
    }
  ]
}

Response definitions

count integer

Required. Number of agents.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results array of objects

Required. Array of objects with information about agents.

id integer

Agent ID.

name string [ 1 .. 255 ] characters

Required. Agent name.

route string <= 255 characters Nullable

Agent route.

agent_role string <= 255 characters

Required. Agent role.