Array of multiple Space objects

  • Type: array object[] · Array of multiple Space objects
    • 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

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

    • 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

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

    • status_id
      Type: integer

      ID of the currently active Status for this space

    • status_system
      Type: object · System status

      Status system object

    • 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

    • 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

    • 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