Modules

List modules

get/module

Request

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

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user that created this module

updatedstring date-time

Last updated timestamp

updatedUserIdinteger

ID of user who last updated this record

iconNamestring required

FontAwesome icon name (e.g. 'database', 'user').

iconPrefixstring required

FontAwesome icon style prefix (e.g. 'fas', 'far', 'fab').

namestring required

Display name of the module, unique within a space.

descriptionstring nullable

More detailed description of the module

colorstring required

Accent color for the module displayed in the UI, in 6-digit HEX format (e.g. '#FF5733').

boostIdstring

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

isDemoboolean

Whether this module is a demo module

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "updated": "2026-01-15T09:30:00Z",
    "updatedUserId": 42,
    "iconName": "Sample iconName",
    "iconPrefix": "string",
    "name": "Sample name",
    "description": "string",
    "color": "#1f6feb",
    "boostId": "string",
    "isDemo": true
  }
]

Changes

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