Reference

invitations

Invitations to join an org, sent and received. Index · shared schemas · errors.

Procedure	Summary	REST	MCP tool	Stability
`invitations.create`	Invite an email address to an org with a role and mail the invitation. Trust class; admins cannot invite owners.	`POST`	—	experimental
`invitations.list`	List an org's invitations, newest first, optionally by status	`GET`	—	experimental
`invitations.revoke`	Revoke a pending invitation ('revoked: false' when it was no longer pending)	`POST`	—	experimental
`invitations.received`	Pending invitations addressed to the signed-in user's verified email	`GET`	—	experimental
`invitations.accept`	Accept an invitation addressed to the signed-in user's verified email and join the org with its role. An invitation for another address is NOT_FOUND.	`POST`	—	experimental

Invite an email address to an org with a role and mail the invitation. Trust class; admins cannot invite owners.


REST	`POST /v1/invitations/create` (input as a JSON body)
RPC	`/rpc/v2/invitations/create`
MCP	not a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: none
Auth	`org:manage`; trust-class: locally only the runtime owner token; in the cloud only an interactive user session re-authenticated within 15 minutes; never an API key or an MCP token
Tenancy	`org`
Troupe Cloud	answered by the control plane
Stability	experimental, since 1.0

Input:

TypeScript

{ orgId: OrgId; email: Email; role: MemberRole }

Output:

TypeScript

{ invitation: Invitation }

Errors: U, NOT_FOUND, ORG_SUSPENDED, CONFLICT.

List an org's invitations, newest first, optionally by status


REST	`GET /v1/invitations/list` (input as query parameters)
RPC	`/rpc/v2/invitations/list`
MCP	not a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: read-only, idempotent
Auth	`org:read`
Tenancy	`org`
Troupe Cloud	answered by the control plane
Stability	experimental, since 1.0

Input:

TypeScript

{ orgId: OrgId; status?: InvitationStatus }

Output:

TypeScript

{ invitations: Invitation[] }

Errors: U, NOT_FOUND.

Revoke a pending invitation ('revoked: false' when it was no longer pending)


REST	`POST /v1/invitations/revoke` (input as a JSON body)
RPC	`/rpc/v2/invitations/revoke`
MCP	not a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: idempotent, destructive
Auth	`org:manage`
Tenancy	`org`
Troupe Cloud	answered by the control plane
Stability	experimental, since 1.0

Input:

TypeScript

{ orgId: OrgId; invitationId: InvitationId }

Output:

TypeScript

{ revoked: boolean }

Errors: U, NOT_FOUND, CONFLICT.

Pending invitations addressed to the signed-in user's verified email


REST	`GET /v1/invitations/received` (input as query parameters)
RPC	`/rpc/v2/invitations/received`
MCP	not a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: read-only, idempotent
Auth	`account:read`
Tenancy	`none`
Troupe Cloud	answered by the control plane
Stability	experimental, since 1.0

Input:

TypeScript

{}

Output:

TypeScript

{ invitations: ReceivedInvitation[] }

Errors: U.

Accept an invitation addressed to the signed-in user's verified email and join the org with its role. An invitation for another address is NOT_FOUND.


REST	`POST /v1/invitations/accept` (input as a JSON body)
RPC	`/rpc/v2/invitations/accept`
MCP	not a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: none
Auth	`account:write`
Tenancy	`none`
Troupe Cloud	answered by the control plane
Stability	experimental, since 1.0

Input:

TypeScript

{ invitationId: InvitationId }

Output:

TypeScript

{ org: Org }

Errors: U, NOT_FOUND, CONFLICT, ORG_SUSPENDED.