Status

  • icon
    Type: string
    required

    Status icon

  • icon_prefix
    Type: string
    required

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

  • name
    Type: string
    required

    Status name

  • 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 color

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

    Creation timestamp

  • created_user_id
    Type: integer

    ID of the user who created this status

  • id
    Type: integer
    read-only

    Unique identifier - primary key

  • spaces
    Type: array integer[]

    IDs of spaces this status is scoped to; empty means the status is available globally within its StatusSystem

  • status_system_id
    Type: integer

    ID of the StatusSystem this status belongs to

  • statusSystem
    Type: object · System status

    StatusSystem object

    • 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

  • weight
    Type: integer

    Display order position; lower values appear first