Collections

The groups a module's records are split into — the rows a board's grid is grouped under.

GET/collections/{moduleId}

List collections

Collections on a module, in module order.

From an extension view: requires the collections:read scope

Path parameters

moduleId*

string

Module id.

bash

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

Example response

json

{
  "collections": [
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c2b1",
      "name": "In progress",
      "color": "#2563eb",
      "position": 0,
      "isCollapsed": false
    }
  ]
}

POST/collections/{moduleId}

Create a collection

Adds a collection to a module.

From an extension view: requires the collections:write scope

Path parameters

moduleId*

string

Module id.

Body

name*	string	Collection name.
color	string	Hex color.
position	number	Sort position — omit to append.

bash

curl -X POST 'https://api.conexus-x.example/api/collections/{moduleId}' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"name":"In progress","color":"#2563eb"}'

Example response

json

{
  "_id": "66f1a2b3c4d5e6f7a8b9c2b1",
  "name": "In progress",
  "color": "#2563eb",
  "position": 0,
  "isCollapsed": false
}

PUT/collections/{collectionId}

Update a collection

Renames, recolours, reorders or collapses a collection.

From an extension view: requires the collections:write scope

Path parameters

collectionId*

string

Collection id.

Body

name	string	New name.
color	string	Hex color.
position	number	New sort position.
isCollapsed	boolean	Collapsed state in the board UI.

bash

curl -X PUT 'https://api.conexus-x.example/api/collections/{collectionId}' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"name":"Closed won"}'

Example response

json

{
  "_id": "66f1a2b3c4d5e6f7a8b9c2b1",
  "name": "In progress",
  "color": "#2563eb",
  "position": 0,
  "isCollapsed": false
}

DELETE/collections/{collectionId}

Delete a collection

Deletes a collection and every record inside it.

From an extension view: requires the collections:write scope

Path parameters

collectionId*

string

Collection id.

bash

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

Example response

json

{
  "message": "Collection deleted."
}