List Teams

Request

GET /v2/teams HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Type Examples Description
page number page=1
 Page number

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "_embedded" : {
    "teams" : [ {
      "id" : 4,
      "name" : "Engineers",
      "timezone" : "America/New_York",
      "photoUrl" : "http://somesite.com/images/avatar.jpg",
      "createdAt" : "2011-04-01T03:18:33Z",
      "updatedAt" : "2012-07-24T20:18:33Z",
      "mention" : "engs",
      "initials" : "E",
      "_links" : {
        "teamMembers" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "..."
    },
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "...",
      "templated" : true
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.teams Array Array of Team objects

Response fields

Path Type Description
id Number Team’s ID
name String Team’s name
initials String Team’s initials
mention String Mention handle - it can be used to mention a team in the thread body using the @mention format
createdAt String UTC time when this team was created.
updatedAt String UTC time when this team was modified.
timezone String Teams’s timezone
photoUrl String The teams’s photo, if one exists
Relation Description
page Templated link to request any result page
first Link to grab the first page
last Link to grab the last page
next Link to grab the next page
previous Link to grab the previous page
↑Back to top
© Help Scout 2024