Record API

There's two modes in which responses can be generated:

  • Hierarchical
  • Normalized (reduces response size, translates easier to state)
Get Records - Populate All
Headers
{
  "Content-Type": "application/json",
  "Authorization": "<API_KEY>"
}
Body
{
  "recordTypeId": "project",
  "populate": "*",
  "offset": 0,
  "limit": 8
}
Response
{
  "status": "ok",
  "data": {
    "records": [
      "691b7ad8-2b5c-4ac7-928e-cb75cd3a3217",
      "a050b387-1f95-4440-a470-7859b2d77126",
      "73da1054-05e4-490b-8dd3-874f800b4b0e",
      "7fcac039-d3d0-4edc-b70d-afea23599fe6",
      "cbe21286-3a02-4d36-ad87-08ec164f4a9e",
      "f20ab504-6534-498b-b978-01a10847ced8",
      "efe19dd6-b4c2-4905-9acc-d1b2fa8fedb0",
      "e26e2b20-fafc-4144-9679-2e3f4d9c44b1"
    ],
    "cache": {
      "691b7ad8-2b5c-4ac7-928e-cb75cd3a3217": {
        "id": "691b7ad8-2b5c-4ac7-928e-cb75cd3a3217",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "createdTime": "2024-01-09T17:46:54.075Z"
        },
        "events": [],
        "createdTime": "2024-01-09T17:46:54.075Z",
        "updatedTime": null
      },
      "a050b387-1f95-4440-a470-7859b2d77126": {
        "id": "a050b387-1f95-4440-a470-7859b2d77126",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "createdTime": "2024-01-09T17:03:19.836Z"
        },
        "events": [],
        "createdTime": "2024-01-09T17:03:19.836Z",
        "updatedTime": "2024-01-09T17:03:57.680Z"
      },
      "73da1054-05e4-490b-8dd3-874f800b4b0e": {
        "id": "73da1054-05e4-490b-8dd3-874f800b4b0e",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "createdTime": "2024-01-09T17:01:47.490Z"
        },
        "events": [],
        "createdTime": "2024-01-09T17:01:47.490Z",
        "updatedTime": "2024-01-09T17:02:33.158Z"
      },
      "7fcac039-d3d0-4edc-b70d-afea23599fe6": {
        "id": "7fcac039-d3d0-4edc-b70d-afea23599fe6",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "createdTime": "2024-01-09T16:59:04.198Z"
        },
        "events": [],
        "createdTime": "2024-01-09T16:59:04.198Z",
        "updatedTime": "2024-01-09T17:00:39.470Z"
      },
      "cbe21286-3a02-4d36-ad87-08ec164f4a9e": {
        "id": "cbe21286-3a02-4d36-ad87-08ec164f4a9e",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "reference": "OL41119",
          "createdTime": "2024-01-08T20:20:38.627Z"
        },
        "events": [],
        "createdTime": "2024-01-08T20:20:38.627Z",
        "updatedTime": null
      },
      "f20ab504-6534-498b-b978-01a10847ced8": {
        "id": "f20ab504-6534-498b-b978-01a10847ced8",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "createdTime": "2024-01-05T13:45:52.316Z"
        },
        "events": [],
        "createdTime": "2024-01-05T13:45:52.316Z",
        "updatedTime": "2024-01-05T13:44:19.523Z"
      },
      "efe19dd6-b4c2-4905-9acc-d1b2fa8fedb0": {
        "id": "efe19dd6-b4c2-4905-9acc-d1b2fa8fedb0",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "createdTime": "2024-01-05T13:44:19.187Z"
        },
        "events": [],
        "createdTime": "2024-01-05T13:44:19.187Z",
        "updatedTime": "2024-01-05T13:43:03.138Z"
      },
      "e26e2b20-fafc-4144-9679-2e3f4d9c44b1": {
        "id": "e26e2b20-fafc-4144-9679-2e3f4d9c44b1",
        "recordTypeId": "project",
        "fields": {
          "name": "Project A",
          "createdTime": "2024-01-05T13:43:02.801Z"
        },
        "events": [],
        "createdTime": "2024-01-05T13:43:02.801Z",
        "updatedTime": "2024-01-05T13:42:26.377Z"
      }
    },
    "meta": {
      "population": []
    }
  }
}
Endpoints
POST
/v1/:type
Create a record
POST
/v1/:type/:id
Update a record
GET
/v1/:type/:id
Get a record
GET
/v1/:type
Get records
POST
/v1/:type/:id/:action
Execute a record action
POST
/v1/:type/:id/softdelete
Soft-delete a record
DELETE
/v1/:type/:id
Delete a record
GET
/v1/:type/search
POST
/v1/:type/batch-insert
Batch insert records
POST
/v1/:type/batch-upsert
Batch upsert records
POST
/v1/:type/batch-update
Batch update records
POST
/v1/:type/batch-delete
Batch delete records