Records

List records

get/record

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/record
  • 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.

updatedSinceinteger

Unix timestamp; only return items updated after this point

Response

Records

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

statusSystemIdinteger required

ID of the system-level status (pipeline stage) this record belongs to; must be valid for the module.

statusIdinteger

ID of the user-defined sub-status within the system status.

spaceIdinteger required

ID of the space this record belongs to.

featuredImageIdinteger

ID of the File used as the default image for this record.

filesinteger[]

IDs of files attached to this record.

labelsinteger[]

IDs of labels assigned to this record.

boostIdstring

Globally unique cross-system identifier for this record (used for integrations and deduplication).

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "statusSystemId": 42,
    "statusId": 42,
    "spaceId": 42,
    "featuredImageId": 42,
    "files": [
      1
    ],
    "labels": [
      1
    ],
    "boostId": "string",
    "customFieldsValues": [
      {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "valueWysiwyg": "string",
        "valueInt": 1,
        "valueFloat": 1.5,
        "valueDatetime": "2026-01-15T09:30:00Z",
        "valueModule": "string",
        "fileId": 42,
        "customFieldInputId": 42,
        "table": "string",
        "entityId": 42,
        "customFieldInputName": "Sample customFieldInputName",
        "selected": "string",
        "ipAddress": "string",
        "translatable": true
      }
    ]
  }
]

Changes

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