Space

  • accountingUnit
    Type: string

    Accounting unit (module setting field, shown only on space type contact or business process)

  • assigned_categories
    Type: array integer[]

    IDs of categories assigned to this space

  • assigned_teams
    Type: array integer[]

    IDs of teams assigned to this space

  • assigned_users
    Type: array integer[]

    IDs of users directly assigned to this space

  • boostId
    Type: string
    read-only

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

  • businessCaseAddButtonOptions
    Type: array string[] enum

    Configures places where to display button Add business case (module setting field, shown only on space module business-process )

    values
    • offer
    • order
    • reservation
  • businessCaseMask
    Type: string

    Mask used for generating numbers of new Business Case records (module setting field, shown only on space module business-process )

  • businessContractAddButtonOptions
    Type: array string[] enum

    Configures places where to display button Add business contract (module setting field, shown only on space module business-process )

    values
    • offer
    • order
    • reservation
  • businessContractMask
    Type: string

    Mask used for generating numbers of new Business Contract records (module setting field, shown only on space module business-process )

  • businessOfferMask
    Type: string

    Mask used for generating numbers of new Business Offer records (module setting field, shown only on space module business-process )

  • businessOrderMask
    Type: string

    Mask used for generating numbers of new Business Order records (module setting field, shown only on space module business-process )

  • categories
    Type: object · Role matrix

    Matrix of connected category ids with their respective roles

    • manager
      Type: array integer[]

      MANAGER IDs

    • member
      Type: array integer[]

      MEMBER IDs

    • owner
      Type: array integer[]

      OWNER IDs

  • chatRooms
    Type: array integer[]

    Connected chat-room ids

  • color
    Type: string

    Color in hex

  • controls
    Type: array object[]

    UI control configuration entries for the todo module (module setting field, shown only on space module todo)

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

    Creation timestamp

  • createdUserId
    Type: integer
    read-only

    ID of user who created this record

  • customFieldsValues
    Type: array object[] · FieldValue[]

    Custom fields

    A single custom field value attached to a record. The field is identified either by customFieldInputId, or by customFieldInputName + module. Values of computed fields (inputType calculation and rollup) are read-only: a calculation value is evaluated at read time from the field's inputCalculation formula and never stored, a rollup value is recomputed automatically from related records; writes to either are ignored.

    • value
      Type: string
      required

      The field value as a string; the actual storage column (valueInt, valueFloat, valueDatetime, valueWysiwyg) used internally is determined by the field's inputType. For inputType calculation and rollup this value is computed by the system and read-only — see the schema description.

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

      Creation datetime

    • customFieldInputId
      Type: integer

      Field id. If this field is not specified, ID is loaded using customFieldInputName and module

    • customFieldInputName
      Type: string

      Name of field which gets filled. Applied only when customFieldInputId is not set

    • entityId
      Type: integer

      ID of the record (within the given module) that this value is attached to.

    • fileId
      Type: integer

      ID of the uploaded file; used when the field inputType is 'file'.

    • id
      Type: integer
      read-only

      Unique identifier of this field value record.

    • ipAddress
      Type: string

      IP address from which this value was submitted; used for GDPR, newsletter, and cookie acceptance inputs.

    • module
      Type: string · All modules in system (dash syntax)

      Module this field value belongs to

      Module name in kebab-case (dash-separated) format, used in URL path parameters. Open set (built-ins plus custom modules); not restricted to an enum.

    • selected
      Type: boolean

      TRUE if this value is selected (used for checkboxes and radio sets)

    • table
      Type: string

      Module table (if module has more tables). If not filled, is loaded automatically

    • translatable
      Type: boolean

      Is field translatable

    • translations
      Type: object · TranslationLanguage
    • valueDatetime
      Type: string Format: date-time
      read-only

      Input value, stored as Datetime (inner db representation of DATETIME value

    • valueFloat
      Type: number Format: float
      read-only

      Input value, stored as Float (inner db representation of DOUBLE value

    • valueInt
      Type: integer
      read-only

      Input value, stored as Integer (inner db representation of INT value

    • valueModule
      Type: string

      Module of connected entity. It's only for values from connected-value fields.

    • valueWysiwyg
      Type: string
      read-only

      Input value, stored as Wysiwig (inner db representation of TEXT value)

  • customModuleId
    Type: integer

    ID of the custom module definition associated with this space, if it was created as a custom module space

  • depth
    Type: integer
    read-only

    Level of depth inside current tree (nested set model)

  • description
    Type: string

    More detailed description of space

  • editAllowSeconds
    Type: integer

    How many seconds can work reports of this space be edited, after their creation. Used for locking purposes. (module setting field, shown only on space type work )

  • estimated_time
    Type: integer

    Amount of minutes as an estimated time for this todo list

  • files
    Type: array object[] · Array of multiple File objects

    List of attached files

    • statusSystemId
      Type: integer
      required

      ID of the system status that determines the file lifecycle stage

    • boostId
      Type: string
      read-only

      Globally unique boost.space identifier for this record (UUID-like)

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

      Creation timestamp

    • createdUserId
      Type: integer
      read-only

      ID of user who created this record

    • customFieldsValues
      Type: array object[] · FieldValue[]

      Values of space-specific custom fields attached to this file

      A single custom field value attached to a record. The field is identified either by customFieldInputId, or by customFieldInputName + module. Values of computed fields (inputType calculation and rollup) are read-only: a calculation value is evaluated at read time from the field's inputCalculation formula and never stored, a rollup value is recomputed automatically from related records; writes to either are ignored.

    • customType
      Type: integer

      ID of the custom type classification applied to this file

    • fileName
      Type: string
      read-only

      Internal filename as stored on disk (may differ from the original upload name)

    • filesize
      Type: string
      read-only

      Human-readable file size string (e.g. '4 kB')

    • id
      Type: integer
      read-only

      Unique identifier - primary key

    • isFeaturedImage
      Type: boolean

      When true, this image is used as the featured/cover image for the parent record

    • labels
      Type: array array object[][] · Array of multiple Label objects[]

      Labels attached to this file

    • name
      Type: string

      Original file name (human-readable)

    • path
      Type: string

      Relative storage path where the file is persisted on the server or remote storage

    • publicUrl
      Type: string
      read-only

      Publicly accessible URL for reading the file without authentication

    • resize
      Type: array object[] · Array of thumbnails resizes
    • status
      Type: object · Status

      Full Status object for the user-defined status applied to this file

    • statusId
      Type: integer

      ID of the user-defined status applied to this file

    • statusSystem
      Type: object · System status

      Full StatusSystem object for the system lifecycle status applied to this file

    • storage
      Type: integer
      read-only

      Storage flag (0 = local disk, non-zero = remote/cloud storage)

    • type
      Type: string
      read-only

      MIME type of the file (e.g. image/png, application/pdf)

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

      Last updated timestamp

    • updatedUserId
      Type: integer
      read-only

      ID of user who last updated this record

    • usage
      Type: array array object[][] · Array of multiple FileUsage objects[]
      read-only

      List of records across modules that reference this file

  • gistSync
    Type: boolean
    deprecated

    If contacts in this space are synchronized with Gist (module setting field, shown only on space type contact)

  • id
    Type: integer
    read-only

    Unique identifier - primary key

  • invoiceMask
    Type: string

    Mask used for generating numbers of new Invoice records (module setting field, shown only on space module business-process )

  • is_visible
    Type: boolean

    Whether this space is visible to non-owner users in listings

  • isVirtual
    Type: boolean

    Determine if this stock is virtual (module setting field, shown only on space type stock )

  • lft
    Type: integer
    read-only

    LEFT edge for tree identification (nested set model)

  • module
    Type: string

    Module type this space belongs to (e.g. contact, deal, todo, work, product, stock-item, business-process)

  • name
    Type: string

    Name of the Space

  • notificationOnSpaceCreate
    Type: boolean

    Check for triggerring notifications about created sub-space (module setting field, shown only on space module business-process )

  • pages
    Type: array integer[]

    Connected page ids

  • parent_node_id
    Type: integer

    ID of the parent space in the nested set tree; null means this is a root-level space

  • prestashopSync
    Type: boolean
    deprecated

    If products in this space are synchronized with prestashop (module setting field, shown only on space type product)

  • purchaseMask
    Type: string

    Mask used for generating numbers of new Purchase records (module setting field, shown only on space module business-process )

  • reservable
    Type: boolean

    If products in this space are reservable (module setting field, shown only on space module product )

  • reservationUnit
    Type: string

    Sets minimal reservation unit for products in this space (module setting field, shown only on space type product )

  • rgt
    Type: integer
    read-only

    RIGHT edge for tree identification (nested set model)

  • right
    enum
    const:  
    project

    Name of parent module

    values
    • project
  • right_id
    Type: integer

    ID of the parent module record this space is nested under

  • spacesAllowed
    Type: object

    Sub-spaces permitted to be nested under this space, keyed by module, e.g. product => [11]

    • propertyName
      Type: array integer[]
  • status_id
    Type: integer

    ID of the currently active Status for this space

  • status_system
    Type: object · System status

    Status system 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

  • status_system_id
    Type: integer

    ID of the StatusSystem that provides the available statuses for records in this space

  • teams
    Type: object · Role matrix

    Matrix of connected team ids with their respective roles

    • manager
      Type: array integer[]

      MANAGER IDs

    • member
      Type: array integer[]

      MEMBER IDs

    • owner
      Type: array integer[]

      OWNER IDs

  • trid
    Type: integer
    read-only

    Tree Id identification (for multiple trees separation in nested set model)

  • users
    Type: object · Role matrix

    Matrix of connected user ids with their respective roles

    • manager
      Type: array integer[]

      MANAGER IDs

    • member
      Type: array integer[]

      MEMBER IDs

    • owner
      Type: array integer[]

      OWNER IDs

  • vectorSearchEnabled
    Type: boolean

    If true, text/wysiwyg field value writes inside this space are embedded synchronously and the /record/vector/* endpoints are available; if false, vector-search endpoints respond 403 (code 4237) and writes do not generate embeddings

  • weight
    Type: integer

    Weight, for ordering purposes