Skip to content

List memberships of a team

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

Cursor-paginated. Sort order is binding-defined (for example joinedAt ascending).

teamId
required
string

TeamId — opaque branded string.

limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

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

Page of team memberships.

Media typeapplication/json
object
data
required
Array<object>
object
teamId
required
string
userId
required
string
role
required

Role on a team membership.

string
Allowed values: member admin
joinedAt
required
string
hasMore
required
boolean
nextCursor
string
Example
{
"data": [
{
"role": "member"
}
]
}

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"
}
}

No team with that id under this tenant.

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"
}
}