Record values

Cell values — one row per (record, column) pair, plus the resolved view of every reference/mirror column on a module.

GET/record-values/{recordId}

List a record's values

Every cell on one record, each with its column populated.

From an extension view: requires the values:read scope

Path parameters

recordId*

string

Record id.

bash

curl -X GET 'https://api.conexus-x.example/api/record-values/{recordId}' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "values": [
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c5e1",
      "record": "66f1a2b3c4d5e6f7a8b9c4d1",
      "column": {
        "_id": "66f1a2b3c4d5e6f7a8b9c3c1",
        "name": "Stage",
        "type": "status",
        "position": 1,
        "width": 160,
        "isRequired": false,
        "isHidden": false,
        "statusOptions": [
          {
            "label": "Hot",
            "color": "#ef4444"
          },
          {
            "label": "Warm",
            "color": "#f59e0b"
          },
          {
            "label": "Cold",
            "color": "#3b82f6"
          }
        ]
      },
      "value": "Hot",
      "createdAt": "2026-02-01T10:00:05.000Z",
      "updatedAt": "2026-08-02T15:40:11.000Z"
    }
  ]
}

GET/record-values/references/{moduleId}

Resolve mirrored values

Every reference/relation column on a module, resolved for every record in one request — recordId → columnId → resolved value.

From an extension view: requires the values:read scope

Path parameters

moduleId*

string

Module id.

bash

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

Example response

json

{
  "references": {
    "66f1a2b3c4d5e6f7a8b9c4d1": {
      "66f1a2b3c4d5e6f7a8b9c3c1": {
        "items": [
          {
            "recordId": "66f1a2b3c4d5e6f7a8b9c4d1",
            "name": "Northwind — renewal",
            "value": "Hot"
          }
        ],
        "display": "Hot"
      }
    }
  }
}

POST/record-values

Set a cell

Creates the value row for a (record, column) pair that has none yet.

From an extension view: requires the values:write scope

Body

record*	string	Record id.
column*	string	Column id.
collectionName*	string	The record's collection id.
module*	string	Module id.
workspace*	string	Workspace id.
value*	unknown	Encoding depends on the column's type — see the type reference on this page.

Value encoding by column type — status: plain label string · checkbox: "true"/"false" · person/people: JSON array of user ids · rating: decimal string in 0.5 steps ("3.5") · timeline: JSON {startDate,endDate} · everything else: plain string.

bash

curl -X POST 'https://api.conexus-x.example/api/record-values' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"record":"66f1a2b3c4d5e6f7a8b9c4d1","column":"66f1a2b3c4d5e6f7a8b9c3c1","collectionName":"66f1a2b3c4d5e6f7a8b9c2b1","module":"66f1a2b3c4d5e6f7a8b9c1a1","workspace":"66f1a2b3c4d5e6f7a8b9c0d1","value":"Hot"}'

Example response

json

{
  "_id": "66f1a2b3c4d5e6f7a8b9c5e1",
  "record": "66f1a2b3c4d5e6f7a8b9c4d1",
  "column": {
    "_id": "66f1a2b3c4d5e6f7a8b9c3c1",
    "name": "Stage",
    "type": "status",
    "position": 1,
    "width": 160,
    "isRequired": false,
    "isHidden": false,
    "statusOptions": [
      {
        "label": "Hot",
        "color": "#ef4444"
      },
      {
        "label": "Warm",
        "color": "#f59e0b"
      },
      {
        "label": "Cold",
        "color": "#3b82f6"
      }
    ]
  },
  "value": "Hot",
  "createdAt": "2026-02-01T10:00:05.000Z",
  "updatedAt": "2026-08-02T15:40:11.000Z"
}

PUT/record-values/{recordValueId}

Change a cell

Updates an existing value row.

From an extension view: requires the values:write scope

Path parameters

recordValueId*

string

Record value id.

Body

value*

unknown

New value — same encoding rules as creating one.

bash

curl -X PUT 'https://api.conexus-x.example/api/record-values/{recordValueId}' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"value":"Cold"}'

Example response

json

{
  "_id": "66f1a2b3c4d5e6f7a8b9c5e1",
  "record": "66f1a2b3c4d5e6f7a8b9c4d1",
  "column": {
    "_id": "66f1a2b3c4d5e6f7a8b9c3c1",
    "name": "Stage",
    "type": "status",
    "position": 1,
    "width": 160,
    "isRequired": false,
    "isHidden": false,
    "statusOptions": [
      {
        "label": "Hot",
        "color": "#ef4444"
      },
      {
        "label": "Warm",
        "color": "#f59e0b"
      },
      {
        "label": "Cold",
        "color": "#3b82f6"
      }
    ]
  },
  "value": "Hot",
  "createdAt": "2026-02-01T10:00:05.000Z",
  "updatedAt": "2026-08-02T15:40:11.000Z"
}

DELETE/record-values/{recordValueId}

Clear a cell

Deletes a value row, returning the cell to empty.

From an extension view: requires the values:write scope

Path parameters

recordValueId*

string

Record value id.

bash

curl -X DELETE 'https://api.conexus-x.example/api/record-values/{recordValueId}' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "message": "Value cleared."
}