Module

  • color
    Type: string
    required

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

  • iconName
    Type: string
    required

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

  • iconPrefix
    Type: string
    required

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

  • name
    Type: string
    required

    Display name of the module, unique within a space.

  • boostId
    Type: string
    read-only

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

  • created
    Type: string Format: date-time
    read-only

    Creation timestamp

  • createdUserId
    Type: integer
    read-only

    ID of user that created this module

  • description
    Type: string | null

    More detailed description of the module

  • id
    Type: integer
    read-only

    Unique identifier - primary key

  • isDemo
    Type: boolean

    Whether this module is a demo module

  • updated
    Type: string Format: date-time
    read-only

    Last updated timestamp

  • updatedUserId
    Type: integer
    read-only

    ID of user who last updated this record