Authentication

Create an API token

Creates a new private API token for the user with optional per-module CRUD permissions. The token value is returned only once in this response.

post/auth/{userId}/token

Request

Base URL: https://test.boost.space/api
URL: https://test.boost.space/api/auth/{userId}/token
Auth: HTTP bearer

Path parameters

userIdinteger required

ID of user

Query parameters

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.

Request body

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

userIdinteger

ID of the user this token authenticates on behalf of

tokenstring

Bearer token value used in the Authorization header

descriptionstring

Human-readable description of the token's purpose

priorityinteger

Default conflict-resolution priority across tokens; lower value takes precedence

boostIdstring

Globally unique boost.space identifier for this record (UUID-like)

allowedIpsstring[]

Whitelist of IPv4/IPv6 addresses or CIDR ranges; empty means unrestricted

mcpboolean

When true, this token is an MCP (Model Context Protocol) token for AI integrations

Example request

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "userId": 42,
  "token": "string",
  "description": "string",
  "priority": 1,
  "boostId": "string",
  "permissions": [
    {
      "id": 42,
      "created": "string",
      "createdUserId": 42,
      "tokenId": 42,
      "module": "activities",
      "create": true,
      "read": true,
      "update": true,
      "delete": true,
      "boostId": "string"
    }
  ],
  "allowedIps": [
    "string"
  ],
  "mcp": true
}

Response

Created token