Skip to main content
GET
List teams

Authorizations

Authorization
string
header
required

Use the Authorization header with Bearer scheme.

Examples:

  • API Key: Authorization: Bearer calid_xxxxx

Query Parameters

page
integer
default:1

Page number for paginated team results.

Required range: x >= 1
Example:

1

limit
integer
default:10

Maximum number of teams returned per page.

Required range: 1 <= x <= 100
Example:

10

orderBy
enum<string>

Field used to sort team results.

Available options:
id,
name,
slug,
createdAt
Example:

"createdAt"

orderDir
enum<string>
default:desc

Sorting direction for team results.

Available options:
asc,
desc
Example:

"desc"

name
string

Case-insensitive partial filter on team name.

Example:

"Growth"

slug
string

Case-insensitive partial filter on team slug.

Example:

"growth-team"

isTeamPrivate
boolean

Filter by private/public team visibility.

Example:

false

Response

Paginated list of teams

Paginated list of teams

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required
message
string