Systems
Systems define the main, side-system and sub-system scopes used to organise account data.
Object schema
Fields returned by List systems. Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
active | object | Required | Active. |
active.sideSystemId | string | Required | Side System Id. |
active.subSystemId | null | string | Optional | Sub System Id. |
active.isUnifiedView | boolean | Optional | Is Unified View. Allowed values: false, true. |
active.updatedAt | number | Required | Most recent update time. |
sideSystems | array<object> | Required | Side Systems. |
sideSystems[]._id | string | Required | Unique identifier. |
sideSystems[].userId | string | Required | Owning account identifier. |
sideSystems[].name | string | Required | Name of the resource. |
sideSystems[].description | string | Optional | Description of the resource. |
sideSystems[].icon | string | Optional | Icon. |
sideSystems[].tagCode | string | Optional | Tag Code. |
sideSystems[].tagColor | string | Optional | Tag Color. |
sideSystems[].memberCount | number | Optional | Member Count. Active members on this side, including those in a nested sub. |
sideSystems[].createdAt | number | Required | Creation time. |
sideSystems[].updatedAt | number | Required | Most recent update time. |
subSystems | array<object> | Required | Sub Systems. |
subSystems[]._id | string | Required | Unique identifier. |
subSystems[].userId | string | Required | Owning account identifier. |
subSystems[].sideSystemId | string | Required | Side System Id. |
subSystems[].parentSubSystemId | null | string | Optional | Parent Sub System Id. |
subSystems[].linkedMemberId | null | string | Optional | Linked Member Id. |
subSystems[].name | string | Required | Name of the resource. |
subSystems[].description | string | Optional | Description of the resource. |
subSystems[].icon | string | Optional | Icon. |
subSystems[].tagCode | string | Optional | Tag Code. |
subSystems[].tagColor | string | Optional | Tag Color. |
subSystems[].createdAt | number | Required | Creation time. |
subSystems[].updatedAt | number | Required | Most recent update time. |
Endpoints
10 operations
PATCHUpdate active system
/api/v1/systems/activeGETList systems/api/v1/systemsGETList assignable members/api/v1/systems/side-systems/{sideSystemId}/assignable-membersPATCHUpdate side system/api/v1/systems/side-systems/{sideSystemId}DELETEDelete side system/api/v1/systems/side-systems/{sideSystemId}POSTCreate side system/api/v1/systems/side-systemsPATCHUpdate sub system/api/v1/systems/sub-systems/{subSystemId}DELETEDelete sub system/api/v1/systems/sub-systems/{subSystemId}POSTCreate sub system/api/v1/systems/sub-systemsPATCHUpdate unified view/api/v1/systems/unified-view