Search developer docs

Teams

List teams

GET/v1/teams

Lists active teams visible to the token owner by default.

Required scopes: team:read

Parameters

`query.includeArchived`	`boolean` Set to true to include archived teams. Defaults to false.
`query.limit`	`integer` Maximum number of records to return. Defaults to 50 and is capped at 200.
`query.cursor`	`string` Cursor returned by page.nextCursor from the previous list response.

Response 200

`data`	`object[]`
`data[].id`	`string:uuid` Team identifier.
`data[].name`	`string` Team display name.
`data[].role`	`string` Role held by the token owner on the team.
`data[].status`	`"active" \| "invited" \| "departed" \| "removed"` Membership status for the token owner on this team.
`data[].organizationStatus`	`"active" \| "archived"` Team organization lifecycle status.
`data[].version`	`number` Current team aggregate version.
`data[].cursor`	`number` Latest event-ledger cursor projected into this team record.
`page`	`object`
`page.limit`	`integer` Maximum number of records returned in this page.
`page.nextCursor`	`string \| null` Cursor to pass as the next request's cursor query parameter, or null when there are no more results.
`meta`	`object`
`meta.cursor`	`number \| null` Highest record cursor represented by this response.