Labels

List connected labels

get/file/{fileId}/label

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/file/{fileId}/label
  • Auth: HTTP bearer

Path parameters

fileIdinteger required

ID of file

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

Connected labels

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

spacesobject

Spaces this label is assigned to, and the optional per-space module restriction. Keys are space IDs; each value is an array of module names (in dash syntax) the label may be attached to within that space, or an empty array / null to allow all modules in that space. An empty spaces object makes the label global - visible to every space and every user.

namestring required

Name of this label

colorstring required

Color of this label

typestring

Scope of this label. SHARED labels are visible to all users with access to the assigned spaces; a SHARED label with no spaces is global and visible to everyone.

modulestring

Name of the module this label can be attached to. When set, the label can only be attached to records of this module. Leave empty to allow any module (subject to per-space restrictions in spaces).

editableboolean

Determines if label can be edited by currently logged user

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "updated": "2026-01-15T09:30:00Z",
    "updatedUserId": 42,
    "spaces": {
      "12": [
        "contact",
        "todo"
      ],
      "34": []
    },
    "name": "Sample name",
    "color": "#1f6feb",
    "type": "string",
    "module": "string",
    "editable": true
  }
]

Changes

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