Members API
Members, invitations and offboarding
POST /invites/{token}/accept
Accepts an invitation as the signed-in account (whose email must match).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
token required | path | string | The invite token |
Responses
200- OK. Accepted
application/json 404- Not found. ProblemBody
application/json
GET /orgs/{org}/invites
Pending invitations (admins).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Responses
200- OK. Paged_Invite
application/json
POST /orgs/{org}/invites
Invites someone by email (admins).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Request body
application/json, CreateInvite.
| Field | Type | Description |
|---|---|---|
email required | string | Who. |
org_role required | string | admin, member or guest. |
space_role | null | Role | |
spaces | string[] | Spaces (slugs or ids) to grant. |
Responses
201- Created. Invite
application/json
GET /orgs/{org}/members
Every human in the org.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Responses
200- OK. Paged_Member
application/json
PATCH /orgs/{org}/members/{handle}
Changes a member's org role (admins; only owners grant or remove owner).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
handle required | path | string | The member's handle |
Request body
application/json, UpdateMember.
| Field | Type | Description |
|---|---|---|
org_role required | OrgRole | The new org role. |
Responses
200- OK. Member
application/json
DELETE /orgs/{org}/members/{handle}
Removes a member (admins, or the member themselves).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
handle required | path | string | The member's handle |
Request body
application/json, Offboarding.
| Field | Type | Description |
|---|---|---|
agents_to | string | null | Give their agents to this human or team (they stay paused). |
private_spaces | string | null | transfer (default) or archive their private spaces. |
private_spaces_to | string | null | Who receives transferred private spaces (default: you). |
reason | string | null | Why (recorded in the audit log). |
reassign_tasks_to | string | null | Reassign their owned tasks to this actor or team handle; unowned if absent. |
revoke_agents | boolean | Revoke their agents instead of pausing them. |
Responses
200- OK. OffboardReport
application/json