Users

List user invitations, or look one up by hash

Visible to any authenticated user; the registration hash is never included in list responses. When the hash query parameter is supplied, the endpoint instead returns the single invitation matching that exact hash (available without authentication, so an invitee can view the invitation before accepting; 404 once accepted) — this is the only response that includes the hash.

get/user/invitation

Request

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

Query parameters

hashstring

Exact registration hash; returns the single matching, not-yet-accepted invitation including its hash

filterstring

Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.

offsetinteger

Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

limitinteger

Maximum number of records to return. Use together with offset for pagination.

orderstring

Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Response

Get List of records

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 response

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

Changes

No recorded changes to this operation across all 1 revision of this API.