Skip to content
Kindgi

List memberships of a team

View as Markdown
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). For the team’s admins (and tenant admins): a plain member sees the team, not who else is in it, and reads their own roles through GET /v1/identity/users/{userId}/grants.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
teamId
required
string

TeamId — opaque branded string.

Query Parameters

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

1..100. Default 25.

cursor
string

Where the previous page ended: its nextCursor, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise 400 bad-input, and the list starts again without it. Absent → first page.

Responses

Section titled “Responses”

200

Section titled “200”

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

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

404

Section titled “404”

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

See also