System status

  • activated
    Type: integer

    Whether this status system is active and available for use; 1 = active, 0 = inactive

  • allow_move
    Type: string

    Serialized JSON rule set defining which status transitions are permitted within this status system

  • boostId
    Type: string
    read-only

    Globally unique identifier for this record in the format EntityName0{id}, usable as a stable cross-entity reference

  • color
    Type: string

    Status system color

  • custom
    Type: boolean

    Whether this is a user-defined custom status system (1) or a built-in system status system (0)

  • icon
    Type: string

    Status system icon

  • icon_prefix
    Type: string

    Font-icon library prefix used to render the icon (e.g. 'fas' for Font Awesome Solid)

  • id
    Type: integer
    read-only

    Unique identifier - primary key

  • module
    Type: string

    Module type this status system is associated with (e.g. contact, deal, todo)

  • name
    Type: string

    Status system name

  • system_name
    Type: string

    Internal system-level identifier for this status system, used to reference built-in status systems by a stable key

  • weight
    Type: integer

    Display order position; lower values appear first