Spaces

List spaces

get/space

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/space
  • Auth: HTTP bearer

Query parameters

filterstring

Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.

offsetinteger

Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

limitinteger

Maximum number of records to return. Use together with offset for pagination.

orderstring

Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Response

Get Space list

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

namestring

Name of the Space

descriptionstring

More detailed description of space

modulestring

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

weightinteger

Weight, for ordering purposes

status_system_idinteger

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

status_idinteger

ID of the currently active Status for this space

colorstring

Color in hex

right'project'

Name of parent module

right_idinteger

ID of the parent module record this space is nested under

lftinteger

LEFT edge for tree identification (nested set model)

rgtinteger

RIGHT edge for tree identification (nested set model)

tridinteger

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

depthinteger

Level of depth inside current tree (nested set model)

parent_node_idinteger

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

is_visibleboolean

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

vectorSearchEnabledboolean

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

estimated_timeinteger

Amount of minutes as an estimated time for this todo list

customModuleIdinteger

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

boostIdstring

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

assigned_usersinteger[]

IDs of users directly assigned to this space

assigned_categoriesinteger[]

IDs of categories assigned to this space

assigned_teamsinteger[]

IDs of teams assigned to this space

spacesAllowedobject

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

chatRoomsinteger[]

Connected chat-room ids

pagesinteger[]

Connected page ids

reservableboolean

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

prestashopSyncboolean

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

reservationUnitstring

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

gistSyncboolean

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

accountingUnitstring

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

controlsobject[]

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

editAllowSecondsinteger

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 )

isVirtualboolean

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

businessContractMaskstring

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

businessCaseMaskstring

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

businessOfferMaskstring

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

businessOrderMaskstring

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

invoiceMaskstring

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

purchaseMaskstring

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

notificationOnSpaceCreateboolean

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

businessCaseAddButtonOptionsstring[]

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

businessContractAddButtonOptionsstring[]

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

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "name": "Sample name",
    "description": "string",
    "module": "string",
    "weight": 1,
    "status_system_id": 42,
    "status_id": 42,
    "color": "#1f6feb",
    "right": "project",
    "right_id": 42,
    "lft": 1,
    "rgt": 1,
    "trid": 42,
    "depth": 1,
    "parent_node_id": 42,
    "is_visible": true,
    "vectorSearchEnabled": true,
    "estimated_time": 1,
    "customModuleId": 42,
    "boostId": "string",
    "assigned_users": [
      1
    ],
    "assigned_categories": [
      1
    ],
    "assigned_teams": [
      1
    ],
    "users": {
      "owner": [
        1
      ],
      "manager": [
        1
      ],
      "member": [
        1
      ]
    },
    "teams": {
      "owner": [
        1
      ],
      "manager": [
        1
      ],
      "member": [
        1
      ]
    },
    "categories": {
      "owner": [
        1
      ],
      "manager": [
        1
      ],
      "member": [
        1
      ]
    },
    "status_system": {
      "id": 42,
      "color": "#1f6feb",
      "icon_prefix": "string",
      "icon": "string",
      "module": "string",
      "weight": 1,
      "name": "Sample name",
      "system_name": "Sample system_name",
      "activated": 1,
      "custom": true,
      "allow_move": "string",
      "boostId": "string"
    },
    "spacesAllowed": {
      "key": [
        1
      ]
    },
    "customFieldsValues": [
      {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "valueWysiwyg": "string",
        "valueInt": 1,
        "valueFloat": 1.5,
        "valueDatetime": "2026-01-15T09:30:00Z",
        "valueModule": "string",
        "value": "string",
        "fileId": 42,
        "customFieldInputId": 42,
        "module": "activities",
        "table": "string",
        "entityId": 42,
        "customFieldInputName": "Sample customFieldInputName",
        "selected": "string",
        "ipAddress": "string",
        "translatable": true,
        "translations": {
          "en": {
            "field1": "translation1",
            "field2": "translation2"
          },
          "it": {
            "field1": "translation1",
            "field2": "translation2"
          },
          "cs": {
            "field1": "translation1",
            "field2": "translation2"
          }
        }
      }
    ],
    "files": [
      {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "createdUserId": 42,
        "updated": "2026-01-15T09:30:00Z",
        "updatedUserId": 42,
        "statusId": 42,
        "statusSystemId": 42,
        "path": "string",
        "fileName": "Sample fileName",
        "name": "Sample name",
        "type": "string",
        "customType": 1,
        "storage": 1,
        "filesize": "string",
        "boostId": "string",
        "customFieldsValues": [
          {
            "id": 42,
            "created": "2026-01-15T09:30:00Z",
            "valueWysiwyg": "string",
            "valueInt": 1,
            "valueFloat": 1.5,
            "valueDatetime": "2026-01-15T09:30:00Z",
            "valueModule": "string",
            "value": "string",
            "fileId": 42,
            "customFieldInputId": 42,
            "module": "activities",
            "table": "string",
            "entityId": 42,
            "customFieldInputName": "Sample customFieldInputName",
            "selected": "string",
            "ipAddress": "string",
            "translatable": true,
            "translations": {
              "en": {
                "field1": "translation1",
                "field2": "translation2"
              },
              "it": {
                "field1": "translation1",
                "field2": "translation2"
              },
              "cs": {
                "field1": "translation1",
                "field2": "translation2"
              }
            }
          }
        ],
        "publicUrl": "https://acme.boost.space",
        "resize": [
          {
            "id": 42,
            "created": "2026-01-15T09:30:00Z",
            "path": "string"
          }
        ],
        "status": {
          "id": 42,
          "created": "2026-01-15T09:30:00Z",
          "created_user_id": 42,
          "name": "Sample name",
          "color": "#1f6feb",
          "icon": "string",
          "icon_prefix": "string",
          "weight": 1,
          "status_system_id": 42,
          "boostId": "string",
          "spaces": [
            1
          ],
          "statusSystem": {}
        },
        "statusSystem": {
          "id": 42,
          "color": "#1f6feb",
          "icon_prefix": "string",
          "icon": "string",
          "module": "string",
          "weight": 1,
          "name": "Sample name",
          "system_name": "Sample system_name",
          "activated": 1,
          "custom": true,
          "allow_move": "string",
          "boostId": "string"
        },
        "labels": [
          []
        ],
        "isFeaturedImage": true,
        "usage": [
          []
        ]
      }
    ],
    "chatRooms": [
      1
    ],
    "pages": [
      1
    ],
    "reservable": true,
    "prestashopSync": true,
    "reservationUnit": "string",
    "gistSync": true,
    "accountingUnit": "string",
    "controls": [
      {}
    ],
    "editAllowSeconds": 1,
    "isVirtual": true,
    "businessContractMask": "string",
    "businessCaseMask": "string",
    "businessOfferMask": "string",
    "businessOrderMask": "string",
    "invoiceMask": "string",
    "purchaseMask": "string",
    "notificationOnSpaceCreate": true,
    "businessCaseAddButtonOptions": [
      "offer"
    ],
    "businessContractAddButtonOptions": [
      "offer"
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.