Sign in
Teams

List organization teams

Returns a paginated list of teams that belong to the organization the API key is scoped to, ordered by name. Optionally filters by a case-insensitive team name substring match or by archived flag. Requires the workspace:read scope.

get/api/teams

Query parameters

isArchivedboolean

Flag indicating whether to include archived teams in the results.

teamNamestring[]

Case-insensitive substrings to match against team names (ILIKE). Repeat the parameter to filter by multiple names; teams matching any of them are returned.

[
  "design"
]
pagenumber
Example:1

1-based page number. Defaults to 1.

pageSizenumber
Example:20

Number of items per page (1-100). Defaults to 20.

Response

A page of teams in the organization.

Example response

{
  "results": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000000",
      "teamName": "Design Team"
    }
  ],
  "pagination": {
    "totalPages": 5,
    "currentPage": 1,
    "totalCount": 92,
    "pageSize": 20
  }
}

Changes