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.

Path Parameters

  • userId
    Type: integer
    required

    ID of user

Query Parameters

  • filter
    Type: string

    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.

  • offset
    Type: integer
    min:  
    0

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

  • limit
    Type: integer
    min:  
    1

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

  • order
    Type: string

    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.

Body·

required
application/json

Token to be created

  • allowedIps
    Type: array of string

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

  • description
    Type: string

    Human-readable description of the token's purpose

  • mcp
    Type: boolean

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

  • permissions
    Type:

    Per-module CRUD permissions granted to this token

    Properties: 6
  • priority
    Type: integer

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

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/auth/{userId}/token
curl https://test.boost.space/api/auth/1/token \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "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
}'

{
  "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
}

Created token

Previous
List API tokens
Next
Modules