Skip to content
Kindgi

List teams in the caller's tenant

GET
/v1/teams
curl --request GET \
  --url 'https://example.com/v1/teams?limit=25' \
  --header 'Authorization: Bearer <token>'

Cursor-paginated. Optional ?orgId= narrows to a specific org (absent = every team, including teams with no org). ?nameContains= substring-matches on Team.name.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Opaque cursor from a prior response. Absent → first page.

orgId
string

Narrow to teams belonging to a specific org.

nameContains
string

Substring match on Team.name.

Responses

Section titled “Responses”

200

Section titled “200”

Page of teams.

Media typeapplication/json
object
data
required
Array<object>
object
id
required

TeamId — opaque branded string.

string
tenantId
required
string
orgId
string
name
required
string
slug
required
string
description
string
createdAt
required
string
updatedAt
required
string
hasMore
required
boolean
nextCursor
string
Examplegenerated
{
  "data": [
    {
      "id": "example",
      "tenantId": "example",
      "orgId": "example",
      "name": "example",
      "slug": "example",
      "description": "example",
      "createdAt": "example",
      "updatedAt": "example"
    }
  ],
  "hasMore": true,
  "nextCursor": "example"
}

400

Section titled “400”

Malformed query parameter.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}