Sign in

v16

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01720230.5 KB
Teams

List teams

List all the teams that the current user is a member of. user_id=me must be passed in the query parameters.

get/teams

Query parameters

user_idstring

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

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

order_by'created_at'

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

Example:created_at

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

desc'true' | 'false'

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

Example:false

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

limitinteger

The maximum number of items to return (capped at 200).

The maximum number of items to return (capped at 200).

cursorstring

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

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

querystring

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

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

Response

Successful response

Example response

{
  "items": [
    {
      "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
      "display_name": "My Team",
      "profile_image_url": "https://example.com/image.jpg",
      "client_metadata": {
        "key": "value"
      },
      "client_read_only_metadata": {
        "key": "value"
      }
    }
  ],
  "pagination": {
    "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
  }
}