Skip to content

Accept invitation

POST
/api/v1/invitations/accept
curl --request POST \
--url http://localhost:3000/api/v1/invitations/accept \
--header 'Content-Type: application/json' \
--data '{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "name": "John Doe", "password": "SecureP@ssw0rd!" }'

Accepts an invitation and adds the user to the organization. If the user does not exist, name and password are required.

x-organization-id
string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Media typeapplication/json
object
token
required

Invitation token from the invitation email

string
Example
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
name

Display name for the new user (required if user does not exist)

string
>= 2 characters <= 100 characters
Example
John Doe
password

Password for the new user (required if user does not exist)

string
>= 8 characters <= 128 characters
Example
SecureP@ssw0rd!

Invitation accepted successfully

Invalid token, expired invitation, or missing required fields

Invitation not found

Invitation already accepted