Skip to content
Catalyzed Docs
Create Account Sign In

List teams

GET
/teams

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
teamIds

Comma-separated list of team IDs to filter by

string
nullable

Comma-separated list of team IDs to filter by

name

Filter teams by name (partial match)

string

Filter teams by name (partial match)

page

Page number for pagination (1-indexed)

number
>= 1

Page number for pagination (1-indexed)

pageSize

Number of results per page (1-100, default: 20)

number
>= 1 <= 100

Number of results per page (1-100, default: 20)

orderBy

Field to sort results by

string
Allowed values: createdAt name

Field to sort results by

orderDirection

Sort direction: ascending or descending

string
Allowed values: asc desc

Sort direction: ascending or descending

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Teams retrieved successfully

object
teams
required

Array of teams the user has access to

Array<object>
object
teamId
required

Unique identifier for the team (nanoid format)

string
name
required

Human-readable name for the team

string
createdAt
required

When the team was created (ISO 8601)

string format: date-time
updatedAt
required

When the team was last modified (ISO 8601)

string format: date-time
total
required

Total number of teams matching the query (before pagination)

number
page
required

Current page number

number
pageSize
required

Number of results per page

number

403

Section titled “403 ”

Forbidden - insufficient permissions to access requested teams