Skip to main content
POST
TypeScript SDK

Invite someone with the default role

invite_someone

Authorizations

Authorization
string
header
required

A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

An invitation that gives the Workspace's default role, the one an agent sends. It names no roles: only a person chooses those.

email
string<email>
required

An email address

Maximum string length: 255
Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Response

Successful response

data
object
required

The base info about a user. id stays Identity.UserID (not Auditable's Identity.UUID) so the wire/auth contract keeps the actor scalar.

meta
object
required