Teams

How to list all Teams

Request Overview

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

Fields

Team Object

Field	Type	Specifics
`id`	`Int`	Team ID
`name`	`String`	Team Name
`members`	`array`	Members of the Team

Requests

Get All Teams

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

GET /api/v1/teams 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": "Support Team",
      "members": [
        {
          "id": 5,
          "name": "Team Member One",
          "email": "team-member-one@example.com",
          "is_agent": true
        }
      ]
    },
    {
      "id": 2,
      "name": "Development Team",
      "members": [
        {
          "id": 5,
          "name": "Team Member One",
          "email": "team-member-one@example.com",
          "is_agent": true
        },
        {
          "id": 2,
          "name": "Team Member Two",
          "email": "team-member-two@example.com",
          "is_agent": true
        }
      ]
    },
    ...
  ],
  "links": {
    ...
  },
  "meta": {
    ...
  }
}