Skip to main content
GET
List Teams

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

ID of the Organization to list Teams for.

Query Parameters

names
string[]

A list of names for Teams to filter by. The API returns details only for the specified Teams.

workspaceId
string

The ID of the Workspace to filter the list of Teams for. When specified, the API returns only Teams with a role in the specified Workspace.

deploymentId
string

The ID of the Deployment to filter the list of Teams for. When specified, the API returns only Teams with a role in the specified Deployment.

offset
integer
default:0

Offset for pagination

Required range: x >= 0
limit
integer
default:20

Limit for pagination

Required range: 0 <= x <= 1000
sorts
enum<string>[]

Sorting criteria, each criterion should conform to format 'fieldName:asc' or 'fieldName:desc'

Available options:
name:asc,
name:desc,
description:asc,
description:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

limit
integer
required

The maximum number of Teams in one page.

Example:

10

offset
integer
required

The offset of the current page of Teams.

Example:

0

teams
object[]
required

The list of Teams in the current page.

totalCount
integer
required

The total number of Teams.

Example:

100