v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Teams

Get all teams

Get all teams. Can be used to search for teams using the filter[keyword] and filter[me] query parameters.

get/api/v2/team

Query parameters

page[number]integer

Specific page number to return.

page[size]integer

Example:10

Size for a given page. The maximum allowed value is 100.

sort'name' | '-name' | 'user_count' | '-user_count'

Specifies the order of the returned teams

includeListTeamsInclude[]

Included related resources optionally requested. Allowed enum values: team_links, user_team_permissions

filter[keyword]string

Search query. Can be team name, team handle, or email of team member

filter[me]boolean

When true, only returns teams the current user belongs to

fields[team]TeamsField[]

List of fields that need to be fetched.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "avatar": "🥑",
        "handle": "example-team",
        "name": "Example Team"
      },
      "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
      "relationships": {
        "team_links": {
          "data": [
            {
              "id": "f9bb8444-af7f-11ec-ac2c-da7ad0900001",
              "type": "team_links"
            }
          ],
          "links": {
            "related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
          }
        },
        "user_team_permissions": {
          "data": {
            "id": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595",
            "type": "user_team_permissions"
          },
          "links": {
            "related": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"
          }
        }
      },
      "type": "team"
    }
  ],
  "included": [
    {
      "relationships": {
        "org": {
          "data": {
            "id": "00000000-0000-beef-0000-000000000000",
            "type": "orgs"
          }
        },
        "other_orgs": {
          "data": []
        },
        "other_users": {
          "data": []
        },
        "roles": {
          "data": [
            {
              "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
              "type": "roles"
            }
          ]
        }
      },
      "type": "users"
    }
  ]
}