Team
Members, roles, invites.
7 endpoints.
GET /v1/team/membersPATCH /v1/team/members/{membership_id}DELETE /v1/team/members/{membership_id}GET /v1/team/invitesPOST /v1/team/invitesDELETE /v1/team/invites/{invite_id}POST /v1/team/invites/accept
GET
/v1/team/membersTeam Members List
Needs a key or a dashboard session
Responses
- 200Successful Response
MemberOut[]
PATCH
/v1/team/members/{membership_id}Team Members Update
Needs a key or a dashboard session
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
membership_id | path | string | yes |
Request body application/json MemberUpdate
| Name | Type | Required | Description |
|---|---|---|---|
role | "owner" | "admin" | "editor" | "viewer" | yes |
Responses
- 200Successful Response
MemberOut
DELETE
/v1/team/members/{membership_id}Team Members Remove
Needs a key or a dashboard session
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
membership_id | path | string | yes |
Responses
- 200Successful Response
Deleted
GET
/v1/team/invitesTeam Invites List
Needs a key or a dashboard session
Responses
- 200Successful Response
InviteOut[]
POST
/v1/team/invitesTeam Invites Create
Needs a key or a dashboard session
Request body application/json InviteCreate
| Name | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | |
role | "admin" | "editor" | "viewer" | yes |
Responses
- 201Successful Response
InviteOut
DELETE
/v1/team/invites/{invite_id}Team Invites Revoke
Needs a key or a dashboard session
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
invite_id | path | string | yes |
Responses
- 200Successful Response
Deleted
POST
/v1/team/invites/acceptTeam Invites Accept
Needs a key or a dashboard session
Request body application/json TokenRequest
| Name | Type | Required | Description |
|---|---|---|---|
token | string | yes | min length 20 · max length 200 |
Responses
- 200Successful Response
TenantOut
Data shapes on this page
MemberOut
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
user_id | string | yes | |
email | string | yes | |
name | string | null | yes | |
role | "owner" | "admin" | "editor" | "viewer" | yes | |
created_at | string (date-time) | yes |
MemberUpdate
| Name | Type | Required | Description |
|---|---|---|---|
role | "owner" | "admin" | "editor" | "viewer" | yes |
Deleted
| Name | Type | Required | Description |
|---|---|---|---|
deleted | boolean | no | default true |
id | string | yes |
InviteOut
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
email | string | yes | |
role | "owner" | "admin" | "editor" | "viewer" | yes | |
expires_at | string (date-time) | yes | |
created_at | string (date-time) | yes |
InviteCreate
| Name | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | |
role | "admin" | "editor" | "viewer" | yes |
TokenRequest
| Name | Type | Required | Description |
|---|---|---|---|
token | string | yes | min length 20 · max length 200 |
TenantOut
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
slug | string | yes | |
name | string | yes | |
status | "trialing" | "active" | "past_due" | "suspended" | "canceled" | "deleted" | yes | |
plan_code | string | yes | |
default_locale | string | yes | |
locales | string[] | yes | |
currency | string | yes | |
trial_ends_at | string (date-time) | null | no | |
created_at | string (date-time) | yes |