AI Features

List column data validation configs

get/ai/column-data-validation

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/ai/column-data-validation
  • Auth: HTTP bearer

Query parameters

filterstring

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

offsetinteger

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

limitinteger

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

orderstring

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

Response

List of Ai column data validation config records

idinteger

Unique identifier - primary key

columnKeystring

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

modulestring

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

provider'platform' | 'websearch' | 'custom'

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

promptstring

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

enabledboolean

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

includeEmptyFieldsboolean

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

customInputIdinteger

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

Example response

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

Changes

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