Boost.space API

• OpenAPI Version: 3.1.1
• API Version: 5.5.4

Generated on 23.7.2026 22:20:00

Authentication

All secured endpoints require a Bearer token in the Authorization header: Authorization: Bearer <token>. Tokens are created in the user profile or via POST /auth/{userId}/token.

Servers

• URL: https://{system}.boost.space/api

  • Description: Boost.space client server
  • Variables:
    • system (default: test): Boost.space system name as it appears in the hostname (e.g. for `https://test.boost.space` the value is `test`)

Operations

Get a column data transform config

• Method: GET
• Path: /ai/column-data-transform/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data transform config

integer

Responses

Status: 200 Ai column data transform config record

Content-Type: application/json

• aiCreativity

  string, possible values: "high", "medium", "low" — Controls how expressive and varied the AI output language is; high allows more creative responses.

• aiVoiceTone

  string, possible values: "auto", "professional", "technical", "casual", "straightforward", "confident", "friendly", "humorous", "inspirational" — Determines the style and attitude in which the generated content is delivered.

• columnKey

  string — Identifier of the custom field column this transform is applied to.

• customInputId

  integer — ID of the custom field input (Field) this transform is bound to.

• enabled

  boolean — Whether this column data transform is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• module

  string — System name of the module (e.g. contact, deal) that owns the column being transformed.

• prompt

  string — User-defined instruction sent to the AI to guide how the column value should be transformed.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the transformation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

• type

  string, possible values: "auto", "manual" — Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "prompt": "string",
  "enabled": true,
  "provider": "platform",
  "aiVoiceTone": "auto",
  "aiCreativity": "high",
  "customInputId": 42,
  "type": "auto"
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Update a column data transform config

• Method: PUT
• Path: /ai/column-data-transform/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data transform config

integer

Request Body

Content-Type: application/json

• aiCreativity

  string, possible values: "high", "medium", "low" — Controls how expressive and varied the AI output language is; high allows more creative responses.

• aiVoiceTone

  string, possible values: "auto", "professional", "technical", "casual", "straightforward", "confident", "friendly", "humorous", "inspirational" — Determines the style and attitude in which the generated content is delivered.

• columnKey

  string — Identifier of the custom field column this transform is applied to.

• customInputId

  integer — ID of the custom field input (Field) this transform is bound to.

• enabled

  boolean — Whether this column data transform is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• module

  string — System name of the module (e.g. contact, deal) that owns the column being transformed.

• prompt

  string — User-defined instruction sent to the AI to guide how the column value should be transformed.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the transformation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

• type

  string, possible values: "auto", "manual" — Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "prompt": "string",
  "enabled": true,
  "provider": "platform",
  "aiVoiceTone": "auto",
  "aiCreativity": "high",
  "customInputId": 42,
  "type": "auto"
}

Responses

Status: 200 Updated Ai column data transform config

Content-Type: application/json

• aiCreativity

  string, possible values: "high", "medium", "low" — Controls how expressive and varied the AI output language is; high allows more creative responses.

• aiVoiceTone

  string, possible values: "auto", "professional", "technical", "casual", "straightforward", "confident", "friendly", "humorous", "inspirational" — Determines the style and attitude in which the generated content is delivered.

• columnKey

  string — Identifier of the custom field column this transform is applied to.

• customInputId

  integer — ID of the custom field input (Field) this transform is bound to.

• enabled

  boolean — Whether this column data transform is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• module

  string — System name of the module (e.g. contact, deal) that owns the column being transformed.

• prompt

  string — User-defined instruction sent to the AI to guide how the column value should be transformed.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the transformation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

• type

  string, possible values: "auto", "manual" — Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "prompt": "string",
  "enabled": true,
  "provider": "platform",
  "aiVoiceTone": "auto",
  "aiCreativity": "high",
  "customInputId": 42,
  "type": "auto"
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Create a column data transform config

• Method: POST
• Path: /ai/column-data-transform/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

integer

Request Body

Content-Type: application/json

• aiCreativity

  string, possible values: "high", "medium", "low" — Controls how expressive and varied the AI output language is; high allows more creative responses.

• aiVoiceTone

  string, possible values: "auto", "professional", "technical", "casual", "straightforward", "confident", "friendly", "humorous", "inspirational" — Determines the style and attitude in which the generated content is delivered.

• columnKey

  string — Identifier of the custom field column this transform is applied to.

• customInputId

  integer — ID of the custom field input (Field) this transform is bound to.

• enabled

  boolean — Whether this column data transform is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• module

  string — System name of the module (e.g. contact, deal) that owns the column being transformed.

• prompt

  string — User-defined instruction sent to the AI to guide how the column value should be transformed.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the transformation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

• type

  string, possible values: "auto", "manual" — Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "prompt": "string",
  "enabled": true,
  "provider": "platform",
  "aiVoiceTone": "auto",
  "aiCreativity": "high",
  "customInputId": 42,
  "type": "auto"
}

Responses

Status: 201 Created Ai column data transform config

Content-Type: application/json

• aiCreativity

  string, possible values: "high", "medium", "low" — Controls how expressive and varied the AI output language is; high allows more creative responses.

• aiVoiceTone

  string, possible values: "auto", "professional", "technical", "casual", "straightforward", "confident", "friendly", "humorous", "inspirational" — Determines the style and attitude in which the generated content is delivered.

• columnKey

  string — Identifier of the custom field column this transform is applied to.

• customInputId

  integer — ID of the custom field input (Field) this transform is bound to.

• enabled

  boolean — Whether this column data transform is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• module

  string — System name of the module (e.g. contact, deal) that owns the column being transformed.

• prompt

  string — User-defined instruction sent to the AI to guide how the column value should be transformed.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the transformation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

• type

  string, possible values: "auto", "manual" — Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "prompt": "string",
  "enabled": true,
  "provider": "platform",
  "aiVoiceTone": "auto",
  "aiCreativity": "high",
  "customInputId": 42,
  "type": "auto"
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Delete a column data transform config

• Method: DELETE
• Path: /ai/column-data-transform/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data transform config

integer

Responses

Status: 200 Record succesfully deleted

Content-Type: application/json

• id

  integer — Id of deleted record

• remotes

  array — Remote ids

  Items:

  • id (required)

    string — Remote ID

  • application

    string — Remote Application

  • delete

    boolean — Delete Remote ID

Example:

{
  "id": 1,
  "remotes": [
    {
      "id": "1",
      "application": "string",
      "delete": true
    }
  ]
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

List column data transform configs

• Method: GET
• Path: /ai/column-data-transform
• Tags: AI Features

Parameters

filter

• In: query

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.

string

offset

• In: query

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

integer

limit

• In: query

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

integer

order

• In: query

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.

string

Responses

Status: 200 List of Ai column data transform config records

Content-Type: application/json

Array of:

• aiCreativity

  string, possible values: "high", "medium", "low" — Controls how expressive and varied the AI output language is; high allows more creative responses.

• aiVoiceTone

  string, possible values: "auto", "professional", "technical", "casual", "straightforward", "confident", "friendly", "humorous", "inspirational" — Determines the style and attitude in which the generated content is delivered.

• columnKey

  string — Identifier of the custom field column this transform is applied to.

• customInputId

  integer — ID of the custom field input (Field) this transform is bound to.

• enabled

  boolean — Whether this column data transform is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• module

  string — System name of the module (e.g. contact, deal) that owns the column being transformed.

• prompt

  string — User-defined instruction sent to the AI to guide how the column value should be transformed.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the transformation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

• type

  string, possible values: "auto", "manual" — Specifies whether the AI transformation runs automatically on record change (auto) or only when triggered manually.

Example:

[
  {
    "id": 42,
    "columnKey": "string",
    "module": "string",
    "prompt": "string",
    "enabled": true,
    "provider": "platform",
    "aiVoiceTone": "auto",
    "aiCreativity": "high",
    "customInputId": 42,
    "type": "auto"
  }
]

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Get a column data validation config

• Method: GET
• Path: /ai/column-data-validation/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data validation config

integer

Responses

Status: 200 Ai column data validation config record

Content-Type: application/json

• columnKey

  string — Identifier of the custom field column this validation rule is applied to.

• customInputId

  integer — ID of the custom field input (Field) this validation rule is bound to.

• enabled

  boolean — Whether this column data validation rule is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• includeEmptyFields

  boolean — When true, records with an empty value in the target column are also submitted for validation.

• module

  string — System name of the module (e.g. contact, deal) that owns the column being validated.

• prompt

  string — User-defined instruction sent to the AI describing how the column value should be validated.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the validation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Update a column data validation config

• Method: PUT
• Path: /ai/column-data-validation/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data validation config

integer

Request Body

Content-Type: application/json

• columnKey

  string — Identifier of the custom field column this validation rule is applied to.

• customInputId

  integer — ID of the custom field input (Field) this validation rule is bound to.

• enabled

  boolean — Whether this column data validation rule is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• includeEmptyFields

  boolean — When true, records with an empty value in the target column are also submitted for validation.

• module

  string — System name of the module (e.g. contact, deal) that owns the column being validated.

• prompt

  string — User-defined instruction sent to the AI describing how the column value should be validated.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the validation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}

Responses

Status: 200 Updated Ai column data validation config

Content-Type: application/json

• columnKey

  string — Identifier of the custom field column this validation rule is applied to.

• customInputId

  integer — ID of the custom field input (Field) this validation rule is bound to.

• enabled

  boolean — Whether this column data validation rule is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• includeEmptyFields

  boolean — When true, records with an empty value in the target column are also submitted for validation.

• module

  string — System name of the module (e.g. contact, deal) that owns the column being validated.

• prompt

  string — User-defined instruction sent to the AI describing how the column value should be validated.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the validation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Delete a column data validation config

• Method: DELETE
• Path: /ai/column-data-validation/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data validation config

integer

Responses

Status: 200 Record succesfully deleted

Content-Type: application/json

• id

  integer — Id of deleted record

• remotes

  array — Remote ids

  Items:

  • id (required)

    string — Remote ID

  • application

    string — Remote Application

  • delete

    boolean — Delete Remote ID

Example:

{
  "id": 1,
  "remotes": [
    {
      "id": "1",
      "application": "string",
      "delete": true
    }
  ]
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

List column data validation configs

• Method: GET
• Path: /ai/column-data-validation
• Tags: AI Features

Parameters

filter

• In: query

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.

string

offset

• In: query

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

integer

limit

• In: query

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

integer

order

• In: query

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.

string

Responses

Status: 200 List of Ai column data validation config records

Content-Type: application/json

Array of:

• columnKey

  string — Identifier of the custom field column this validation rule is applied to.

• customInputId

  integer — ID of the custom field input (Field) this validation rule is bound to.

• enabled

  boolean — Whether this column data validation rule is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• includeEmptyFields

  boolean — When true, records with an empty value in the target column are also submitted for validation.

• module

  string — System name of the module (e.g. contact, deal) that owns the column being validated.

• prompt

  string — User-defined instruction sent to the AI describing how the column value should be validated.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the validation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

Example:

[
  {
    "id": 42,
    "columnKey": "string",
    "module": "string",
    "provider": "platform",
    "prompt": "string",
    "enabled": true,
    "includeEmptyFields": true,
    "customInputId": 42
  }
]

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Create a column data validation config

• Method: POST
• Path: /ai/column-data-validation
• Tags: AI Features

Request Body

Content-Type: application/json

• columnKey

  string — Identifier of the custom field column this validation rule is applied to.

• customInputId

  integer — ID of the custom field input (Field) this validation rule is bound to.

• enabled

  boolean — Whether this column data validation rule is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• includeEmptyFields

  boolean — When true, records with an empty value in the target column are also submitted for validation.

• module

  string — System name of the module (e.g. contact, deal) that owns the column being validated.

• prompt

  string — User-defined instruction sent to the AI describing how the column value should be validated.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the validation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}

Responses

Status: 201 Created Ai column data validation config

Content-Type: application/json

• columnKey

  string — Identifier of the custom field column this validation rule is applied to.

• customInputId

  integer — ID of the custom field input (Field) this validation rule is bound to.

• enabled

  boolean — Whether this column data validation rule is active and will be applied during processing.

• id

  integer — Unique identifier - primary key

• includeEmptyFields

  boolean — When true, records with an empty value in the target column are also submitted for validation.

• module

  string — System name of the module (e.g. contact, deal) that owns the column being validated.

• prompt

  string — User-defined instruction sent to the AI describing how the column value should be validated.

• provider

  string, possible values: "platform", "websearch", "custom" — AI backend used for the validation: platform = Boost.space built-in AI, websearch = web-augmented AI, custom = user-configured provider.

Example:

{
  "id": 42,
  "columnKey": "string",
  "module": "string",
  "provider": "platform",
  "prompt": "string",
  "enabled": true,
  "includeEmptyFields": true,
  "customInputId": 42
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Get a column data validation result

• Method: GET
• Path: /ai/column-data-validation-result/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data validation result config

integer

Responses

Status: 200 Ai column data validation result config record

Content-Type: application/json

• aiColumnDataValidationId

  integer — ID of the ColumnDataValidation configuration that produced this result.

• entityId

  string — ID of the record (entity) whose field was validated.

• id

  integer — Unique identifier - primary key

• result

  string — AI-generated validation outcome text for the evaluated record field.

Example:

{
  "id": 42,
  "result": "string",
  "aiColumnDataValidationId": 42,
  "entityId": "string"
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Update a column data validation result

• Method: PUT
• Path: /ai/column-data-validation-result/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data validation result config

integer

Request Body

Content-Type: application/json

• aiColumnDataValidationId

  integer — ID of the ColumnDataValidation configuration that produced this result.

• entityId

  string — ID of the record (entity) whose field was validated.

• id

  integer — Unique identifier - primary key

• result

  string — AI-generated validation outcome text for the evaluated record field.

Example:

{
  "id": 42,
  "result": "string",
  "aiColumnDataValidationId": 42,
  "entityId": "string"
}

Responses

Status: 200 Updated Ai column data validation result config

Content-Type: application/json

• aiColumnDataValidationId

  integer — ID of the ColumnDataValidation configuration that produced this result.

• entityId

  string — ID of the record (entity) whose field was validated.

• id

  integer — Unique identifier - primary key

• result

  string — AI-generated validation outcome text for the evaluated record field.

Example:

{
  "id": 42,
  "result": "string",
  "aiColumnDataValidationId": 42,
  "entityId": "string"
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Delete a column data validation result

• Method: DELETE
• Path: /ai/column-data-validation-result/{entityId}
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data validation result config

integer

Responses

Status: 200 Record succesfully deleted

Content-Type: application/json

• id

  integer — Id of deleted record

• remotes

  array — Remote ids

  Items:

  • id (required)

    string — Remote ID

  • application

    string — Remote Application

  • delete

    boolean — Delete Remote ID

Example:

{
  "id": 1,
  "remotes": [
    {
      "id": "1",
      "application": "string",
      "delete": true
    }
  ]
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

List column data validation results

• Method: GET
• Path: /ai/column-data-validation-result
• Tags: AI Features

Parameters

filter

• In: query

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.

string

offset

• In: query

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

integer

limit

• In: query

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

integer

order

• In: query

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.

string

Responses

Status: 200 List of Ai column data validation result config records

Content-Type: application/json

Array of:

• aiColumnDataValidationId

  integer — ID of the ColumnDataValidation configuration that produced this result.

• entityId

  string — ID of the record (entity) whose field was validated.

• id

  integer — Unique identifier - primary key

• result

  string — AI-generated validation outcome text for the evaluated record field.

Example:

[
  {
    "id": 42,
    "result": "string",
    "aiColumnDataValidationId": 42,
    "entityId": "string"
  }
]

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Create a column data validation result

• Method: POST
• Path: /ai/column-data-validation-result
• Tags: AI Features

Request Body

Content-Type: application/json

• aiColumnDataValidationId

  integer — ID of the ColumnDataValidation configuration that produced this result.

• entityId

  string — ID of the record (entity) whose field was validated.

• id

  integer — Unique identifier - primary key

• result

  string — AI-generated validation outcome text for the evaluated record field.

Example:

{
  "id": 42,
  "result": "string",
  "aiColumnDataValidationId": 42,
  "entityId": "string"
}

Responses

Status: 201 Created Ai column data validation result config

Content-Type: application/json

• aiColumnDataValidationId

  integer — ID of the ColumnDataValidation configuration that produced this result.

• entityId

  string — ID of the record (entity) whose field was validated.

• id

  integer — Unique identifier - primary key

• result

  string — AI-generated validation outcome text for the evaluated record field.

Example:

{
  "id": 42,
  "result": "string",
  "aiColumnDataValidationId": 42,
  "entityId": "string"
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Execute a column data transform on demand

• Method: POST
• Path: /column-data-transform/{entityId}/execute
• Tags: AI Features

Applies a saved column data transform rule to a batch of record IDs, rewriting each record's custom field value according to the configured AI prompt. Requires sufficient AI token balance.

Parameters

entityId required

• In: path

ID of Ai column data validation config

integer

Request Body

Content-Type: application/json

• ids (required)

  array — Record IDs to transform

  Items:

  integer

Example:

{
  "ids": [
    1
  ]
}

Responses

Status: 201 Transformed data.

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Execute a column data validation on demand

• Method: POST
• Path: /ai/column-data-validation/{entityId}/execute
• Tags: AI Features

Parameters

entityId required

• In: path

ID of Ai column data validation config

integer

Request Body

Content-Type: application/json

• ids (required)

  array — Record IDs to validate

  Items:

  integer

Example:

{
  "ids": [
    1
  ]
}

Responses

Status: 201 Transformed data.

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Generate module definitions using AI

• Method: POST
• Path: /ai/generate-custom-modules
• Tags: AI Features

Generates module definitions using AI from a single prompt. Requires sufficient AI token balance.

Request Body

Content-Type: application/json

• prompt

  string | null — User-provided text prompt for the AI tool.

Example:

{
  "prompt": null
}

Responses

Status: 200 Successful operation

Content-Type: application/json

• result

  string — The generated output of the tool

Example:

{
  "result": ""
}

Status: 400 Invalid input or unsupported type

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Generate a value for a custom field using AI

• Method: POST
• Path: /ai/generate-custom-field
• Tags: AI Features

Generates a value for a custom field using AI based on the provided prompt and module context. Requires sufficient AI token balance.

Request Body

Content-Type: application/json

• module

  string | null — Boost.space module identifier related to the tool execution.

• prompt

  string | null — User-provided text prompt for the AI tool.

• table

  string | null — Boost.space table identifier related to the tool execution.

Example:

{
  "prompt": null,
  "table": null,
  "module": null
}

Responses

Status: 200 Successful operation

Content-Type: application/json

• result

  string — The generated output of the tool

Example:

{
  "result": ""
}

Status: 400 Invalid input or unsupported type

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Preview a column data transform without saving

• Method: POST
• Path: /column-data-transform/{entityId}/preview
• Tags: AI Features

Performs a one-time transformation on a single preview object using a custom prompt, without saving any configuration. Useful for testing prompts before creating a transform rule.

Parameters

entityId required

• In: path

ID of Ai column data validation config

integer

Request Body

Content-Type: application/json

• preview (required)

  object — Sample record object to transform

• prompt (required)

  string — AI prompt to test

Example:

{
  "prompt": "",
  "preview": {}
}

Responses

Status: 201 Transformed data.

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 Not found — the requested resource does not exist or is not accessible to the caller. Common causes: invalid ID, record deleted, or record belongs to a different space.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Get OAuth2 client

• Method: GET
• Path: /auth/oauth/client/{clientId}
• Tags: Authentication

Handle OAuth2 client CRUD operations Route: auth/oauth/client[/]

Parameters

clientId required

• In: path

ID of OAuth2 client

integer

Responses

Status: 200 OAuth2 client details

Content-Type: application/json

• clientId

  string — Publicly known OAuth2 client identifier used in authorization and token requests

• clientName

  string — Human-readable display name of the OAuth2 application

• created

  string, format: date-time — Creation timestamp

• createdUserId

  integer — ID of user who created this record

• id

  integer — Unique identifier - primary key

• redirectUris

  array — Permitted redirect URIs that the authorization server will send the auth code to

  Items:

  string

• scopes

  array — OAuth2 scopes this client is authorized to request

  Items:

  string

• tokenId

  integer — ID of the MCP API token linked to this OAuth2 client for machine-to-machine access

• updated

  string, format: date-time — Last update timestamp

• updatedUserId

  integer — ID of user who last updated this record

Example:

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "clientId": "string",
  "clientName": "Sample clientName",
  "redirectUris": [
    "https://acme.boost.space"
  ],
  "scopes": [
    "string"
  ],
  "tokenId": 42
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 OAuth2 client not found

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Update OAuth2 client

• Method: PUT
• Path: /auth/oauth/client/{clientId}
• Tags: Authentication

Updates client name, redirect URIs, or scopes. Include regenerateSecret: true in the request body to rotate the clientSecret.

Parameters

clientId required

• In: path

ID of OAuth2 client

integer

Request Body

Content-Type: application/json

• clientName

  string — Client application name

• clientSecret

  string — New client secret

• redirectUris

  array — Allowed redirect URIs

  Items:

  string

• scope

  string — Space-delimited scopes per RFC 7591

Example:

{
  "clientName": "",
  "clientSecret": "",
  "redirectUris": [
    ""
  ],
  "scope": ""
}

Responses

Status: 200 OAuth2 client updated

Content-Type: application/json

• clientId

  string — Publicly known OAuth2 client identifier used in authorization and token requests

• clientName

  string — Human-readable display name of the OAuth2 application

• created

  string, format: date-time — Creation timestamp

• createdUserId

  integer — ID of user who created this record

• id

  integer — Unique identifier - primary key

• redirectUris

  array — Permitted redirect URIs that the authorization server will send the auth code to

  Items:

  string

• scopes

  array — OAuth2 scopes this client is authorized to request

  Items:

  string

• tokenId

  integer — ID of the MCP API token linked to this OAuth2 client for machine-to-machine access

• updated

  string, format: date-time — Last update timestamp

• updatedUserId

  integer — ID of user who last updated this record

Example:

{
  "id": 42,
  "created": "2026-01-15T09:30:00Z",
  "createdUserId": 42,
  "updated": "2026-01-15T09:30:00Z",
  "updatedUserId": 42,
  "clientId": "string",
  "clientName": "Sample clientName",
  "redirectUris": [
    "https://acme.boost.space"
  ],
  "scopes": [
    "string"
  ],
  "tokenId": 42
}

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 OAuth2 client not found

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Delete OAuth2 client

• Method: DELETE
• Path: /auth/oauth/client/{clientId}
• Tags: Authentication

Revokes the OAuth2 client and immediately invalidates all tokens issued to it.

Parameters

clientId required

• In: path

ID of OAuth2 client

integer

Responses

Status: 200 OAuth2 client deleted

Status: 400 Bad request — the input payload is invalid, missing required fields, or fails validation.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 401 Unauthorized — no valid authentication token was provided, or the token has expired. Authenticate by passing a valid Bearer token in the `Authorization` header.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 403 Forbidden — the authenticated user does not have permission to perform this action. Common causes: missing space membership, insufficient role (e.g. Member trying a Manager-only action), or accessing a record in a space the user cannot view.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

Status: 404 OAuth2 client not found

Status: 500 Internal server error — an unexpected error occurred. This is not caused by the caller.

Content-Type: application/json

• code

  integer — Boost.space error code — the HTTP status for generic errors (e.g. 400, 401, 403, 404, 500) or a specific internal code for finer cases (e.g. 4002 missing required field, 4005 object not found, 4031 2FA required, 4227 OAuth error).

• message

  string — Human-readable description of the error, e.g. `Missing required field: name` or `Object not found: Contact 123`.

Example:

{
  "code": 1,
  "message": "string"
}

List OAuth2 clients

• Method: GET
• Path: /auth/oauth/client
• Tags: Authentication

Parameters

filter

• In: query

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.

string

offset

• In: query

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

integer

limit

• In: query

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

integer

order

• In: query

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.

string

Responses

Status: 200 List of OAuth2 clients

Content-Type: application/json

Array of:

• clientId

  string — Publicly known OAuth2 client identifier used in authorization and token requests

• clientName

  string — Human-readable display name of the OAuth2 application

• created

  string, format: date-time — Creation timestamp

• createdUserId

  integer — ID of user who created this record

• id

  integer — Unique identifier - primary key

• redirectUris

  array — Permitted redirect URIs that the authorization server will send the auth code to

  Items:

  string

• scopes

  array — OAuth2 scopes this client is authorized to request

  Items:

  string

• tokenId

  integer — ID of the MCP API token linked to this OAuth2 client for machine-to-machine access

• updated

  string, format: date-time — Last update timestamp

• updatedUserId

  integer — ID of user who last updated this record