Skip to main content
GET
List teams

Query Parameters

user_id
string

Filter for the teams that the user is a member of. Can be either me or an ID. Must be me in the client API

Example:

"me"

order_by
enum<string>

Field to order results by. Currently only created_at is supported.

Available options:
created_at
Example:

"created_at"

desc
enum<string>

Whether to order results in descending order. Defaults to false (ascending).

Available options:
true,
false
Example:

"false"

limit
integer

The maximum number of items to return (capped at 200). If omitted, all matching teams are returned unpaginated, unless more than 500 teams match, in which case the request fails with a 400 error; set limit and follow pagination.next_cursor instead.

cursor
string

The cursor to start the result set from. Requires limit to also be set.

query
string

A search query to filter the results by. Free-text search applied to the team's id (exact-match) and display name.

Response

200 - application/json

Successful response

items
object[]
required
pagination
object