POST /api/v1/invitationsRequires members.invite permission and an available seat under the current billing plan. The accept_token in the response is returned only once — store it or deliver it to the recipient immediately.
Request body Email address of the person to invite.
UUID of the role to assign when the invitation is accepted.
Number of hours until the invitation expires. Must be at least 1. Defaults to the platform default if omitted.
Response The created invitation. Show Invitation properties
Email address the invitation was sent to.
The role that will be assigned on acceptance. Machine-readable identifier.
Human-readable display name.
Permission strings granted by this role.
UUID of the member who created the invitation.
ISO 8601 datetime when the invitation expires.
Always null at creation time.
ISO 8601 creation timestamp.
One-time acceptance token. Returned only at creation time — it is not stored and cannot be retrieved again. Pass this to the recipient so they can call accept invitation . Errors Status When 400Request body is invalid or missing required fields 401Missing or invalid Bearer token 403Caller lacks members.invite permission or no seats are available 409An active invitation for this email already exists
Example curl -X POST http://localhost:8080/api/v1/invitations \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected] ", "role_id": "r1b2c3d4-e5f6-7890-abcd-ef1234567890", "expires_in_hours": 72 }'
{ "invitation" : { "id" : "i1b2c3d4-e5f6-7890-abcd-ef1234567890" , "email" : "[email protected] " , "role" : { "id" : "r1b2c3d4-e5f6-7890-abcd-ef1234567890" , "key" : "developer" , "name" : "Developer" , "is_system" : true , "permissions" : [ "flags.read" , "flags.write" ] }, "invited_by" : "u1b2c3d4-e5f6-7890-abcd-ef1234567890" , "expires_at" : "2026-03-24T10:00:00Z" , "accepted_at" : null , "created_at" : "2026-03-21T10:00:00Z" }, "accept_token" : "inv_tok_a1b2c3d4e5f67890abcdef1234567890" }