Org / Teams /

List teams

Gets a list of teams belonging to the authenticated org.

Required permission

Os > Team > General > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

teams
[array] required
An array of teams.

{object}
A team object.

id
string required
ID of the team.
pattern
^[A-Za-z0-9-]+$
name
string required
Display name of the team.
description
string
Description of the team.
createdAt
string required
The time the team was created.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/teams

Example response

200 OK

A list of teams belonging to the org.

JSON

{
  "data": {
    "teams": [
      {
        "id": "my-team",
        "name": "My Team",
        "description": "This is my team.",
        "createdAt": "2021-01-20T11:19:53.175Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}