Files

List file records

get/file/

Request

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

Get File list

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

updatedstring date-time

Last updated timestamp

updatedUserIdinteger

ID of user who last updated this record

statusIdinteger

ID of the user-defined status applied to this file

statusSystemIdinteger required

ID of the system status that determines the file lifecycle stage

pathstring

Relative storage path where the file is persisted on the server or remote storage

fileNamestring

Internal filename as stored on disk (may differ from the original upload name)

namestring

Original file name (human-readable)

typestring

MIME type of the file (e.g. image/png, application/pdf)

customTypeinteger

ID of the custom type classification applied to this file

storageinteger

Storage flag (0 = local disk, non-zero = remote/cloud storage)

filesizestring

Human-readable file size string (e.g. '4 kB')

boostIdstring

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

publicUrlstring

Publicly accessible URL for reading the file without authentication

isFeaturedImageboolean

When true, this image is used as the featured/cover image for the parent record

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "updated": "2026-01-15T09:30:00Z",
    "updatedUserId": 42,
    "statusId": 42,
    "statusSystemId": 42,
    "path": "string",
    "fileName": "Sample fileName",
    "name": "Sample name",
    "type": "string",
    "customType": 1,
    "storage": 1,
    "filesize": "string",
    "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",
        "value": "string",
        "fileId": 42,
        "customFieldInputId": 42,
        "module": "activities",
        "table": "string",
        "entityId": 42,
        "customFieldInputName": "Sample customFieldInputName",
        "selected": "string",
        "ipAddress": "string",
        "translatable": true,
        "translations": {
          "en": {
            "field1": "translation1",
            "field2": "translation2"
          },
          "it": {
            "field1": "translation1",
            "field2": "translation2"
          },
          "cs": {
            "field1": "translation1",
            "field2": "translation2"
          }
        }
      }
    ],
    "publicUrl": "https://acme.boost.space",
    "resize": [
      {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "path": "string"
      }
    ],
    "status": {
      "id": 42,
      "created": "2026-01-15T09:30:00Z",
      "created_user_id": 42,
      "name": "Sample name",
      "color": "#1f6feb",
      "icon": "string",
      "icon_prefix": "string",
      "weight": 1,
      "status_system_id": 42,
      "boostId": "string",
      "spaces": [
        1
      ],
      "statusSystem": {}
    },
    "statusSystem": {
      "id": 42,
      "color": "#1f6feb",
      "icon_prefix": "string",
      "icon": "string",
      "module": "string",
      "weight": 1,
      "name": "Sample name",
      "system_name": "Sample system_name",
      "activated": 1,
      "custom": true,
      "allow_move": "string",
      "boostId": "string"
    },
    "labels": [
      []
    ],
    "isFeaturedImage": true,
    "usage": [
      []
    ]
  }
]

Changes

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