Agents

How to list all Agents

Request Overview

Actions	Returns	Description
`GET` /api/v1/agents	`Collection`	Get all teams

Fields

Agent Object

Field	Type	Specifics
`id`	`Int`	Agent ID
`name`	`String`	Agent Name
`email`	`String`	Email Address
`is_agent`	`bool`	Is Agent

Requests

Get All Agents

GET /api/v1/agents Returns, a collection of teams

GET /api/v1/agents HTTP/1.1
Authorization: Bearer {{token}}
Hs-Client-Id: {{hs_client_id}}
Host: api.helpspace.com
Content-Type: application/json; charset=utf-8

200 Response

HTTP/1.1 200 OK
Content-Type: application/json
...

{
  "data": [
        {
          "id": 1,
          "name": "Agent 1",
          "email": "agent1@example.com",
          "is_agent": true
        },
        {
          "id": 2,
          "name": "Agent 2",
          "email": "agent2@example.com",
          "is_agent": true
        },
        {
          "id": 3,
          "name": "Agent 3",
          "email": "agent3@example.com",
          "is_agent": true
        }
  ],
  "links": {
    ...
  },
  "meta": {
    ...
  }
}