Modules

Boards — the unit a workspace is organized into. Modules hold collections, columns and records.

GET/modules/{workspaceId}

List modules

Modules in a workspace, each with its record stats (totalRecords, completedRecords, performance).

From an extension view: requires the modules:read scope

Path parameters

workspaceId*

string

Workspace id.

bash

curl -X GET 'https://api.conexus-x.example/api/modules/{workspaceId}' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "modules": [
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c1a1",
      "name": "Deals",
      "description": "Every open and closed opportunity.",
      "icon": "briefcase",
      "color": "#6a00ff",
      "visibility": "workspace",
      "tags": [
        {
          "label": "Sales",
          "color": "#16a34a"
        }
      ],
      "createdAt": "2026-01-14T09:15:00.000Z",
      "updatedAt": "2026-08-02T15:40:11.000Z",
      "totalRecords": 128,
      "completedRecords": 61,
      "performance": 48
    }
  ]
}

POST/modules/{workspaceId}

Create a module

Creates a module in the given workspace.

From an extension view: requires the modules:write scope

Path parameters

workspaceId*

string

Workspace id.

Body

name*	string	Module name.
description	string	Module description.
tags	{label,color}[]	Free-form labels.

bash

curl -X POST 'https://api.conexus-x.example/api/modules/{workspaceId}' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"name":"Deals","description":"Every open and closed opportunity."}'

Example response

json

{
  "module": {
    "_id": "66f1a2b3c4d5e6f7a8b9c1a1",
    "name": "Deals",
    "description": "Every open and closed opportunity.",
    "icon": "briefcase",
    "color": "#6a00ff",
    "visibility": "workspace",
    "tags": [
      {
        "label": "Sales",
        "color": "#16a34a"
      }
    ],
    "createdAt": "2026-01-14T09:15:00.000Z",
    "updatedAt": "2026-08-02T15:40:11.000Z",
    "totalRecords": 128,
    "completedRecords": 61,
    "performance": 48
  }
}

PUT/modules/{moduleId}

Update a module

Renames, recolours, retags or changes the visibility of a module.

From an extension view: requires the modules:write scope

Path parameters

moduleId*

string

Module id.

Body

name	string	New name.
description	string	New description.
icon	string	Icon catalog key.
color	string	Hex color.
tags	{label,color}[]	Replaces the whole tag set — send [] to clear.
visibility	string	"private" \| "workspace" \| "public". Owner/admin only.

bash

curl -X PUT 'https://api.conexus-x.example/api/modules/{moduleId}' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"visibility":"private"}'

Example response

json

{
  "module": {
    "_id": "66f1a2b3c4d5e6f7a8b9c1a1",
    "name": "Deals",
    "description": "Every open and closed opportunity.",
    "icon": "briefcase",
    "color": "#6a00ff",
    "visibility": "workspace",
    "tags": [
      {
        "label": "Sales",
        "color": "#16a34a"
      }
    ],
    "createdAt": "2026-01-14T09:15:00.000Z",
    "updatedAt": "2026-08-02T15:40:11.000Z",
    "totalRecords": 128,
    "completedRecords": 61,
    "performance": 48
  }
}

DELETE/modules/{moduleId}

Delete a module

Deletes a module and everything inside it — collections, columns, records, cells. Irreversible.

From an extension view: requires the modules:write scope

Path parameters

moduleId*

string

Module id.

bash

curl -X DELETE 'https://api.conexus-x.example/api/modules/{moduleId}' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "message": "Module deleted."
}