Users

Send a user invitation

Sends an email invitation to join the system. Requires role (admin, user, supervisor, guest, or client) and optional team/category assignments. Generates a unique registration link valid until accepted or revoked.

post/user/invitation

Request

Base URL: https://test.boost.space/api
URL: https://test.boost.space/api/user/invitation
Auth: HTTP bearer

Request body

idinteger

Unique identifier - primary key

emailstring

Invited user mail

role'user' | 'admin'

Invited user role

hashstring

One-time token embedded in the invitation link sent to the invited user. Returned only by the hash lookup endpoint (GET /user/invitation?hash=...); omitted from every other response

createdstring date-time

Creation timestamp

acceptedinteger

Whether the invited user has already accepted the invitation (0 = pending, 1 = accepted)

teamsinteger[]

IDs of teams the invited user will be added to upon acceptance

categoriesinteger[]

IDs of categories the invited user will be assigned to upon acceptance

Example request

{
  "id": 42,
  "email": "user@example.com",
  "role": "user",
  "hash": "string",
  "created": "2026-01-15T09:30:00Z",
  "accepted": 1,
  "teams": [
    1
  ],
  "categories": [
    1
  ]
}

Response

Create record