v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Teams

List teams

List teams matching the given parameters, paginated, and ordered.

get/api/teams

Query parameters

cursorstring

Example:WyJuZXh0IiwgIjIwMjItMDEtMDFUMDE6MDA6MDAiLCAxMjNd

Value indicating your position in the list of all teams. If omitted, the first team of the list will be returned.

limitinteger

Maximum number of teams to return.

order_by'created_datetime:asc' | 'created_datetime:desc' | 'name:asc' | 'name:desc'

Attribute used to order teams.

Response

List of teams according to the given criteria.

idinteger

ID of the team.

uristring

URI of the object (auto-generated)

namestring

Name of the team.

descriptionstring nullable

Longer description of the team.

decorationobject nullable

Object describing how the team appears on the webpage. Currently only supports emoji field that shows before the team's name.

created_datetimestring date-time nullable

When the team was created.

Example response

[
  {
    "id": 123,
    "name": "Warehouse team",
    "members": [
      {
        "name": "Marie Curie",
        "email": "marie@gorgias.io",
        "meta": {}
      }
    ]
  }
]