Modules

Get a module by ID

get/module/{moduleId}

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/module/{moduleId}
  • Auth: HTTP bearer

Path parameters

moduleIdinteger required

Module ID

Response

Get one module

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.