Get Record

Get full details of a single record by ID, including description, checklists, custom field values, tags, and assignees.


POST /v1/get-record

Get full details of a single record by ID, including description, checklists, custom field values, tags, and assignees. Use list-records first to find record IDs.

Request body

FieldTypeRequiredDescription
workspaceIdstringYesThe workspace ID
recordIdstringYesThe record ID
{
  "workspaceId": "string",
  "recordId": "string"
}

Response

{
  "id": "string",
  "uid": "string",
  "title": "string",
  "text": "string",
  "html": "string",
  "done": true,
  "archived": true,
  "position": 0,
  "startedAt": "2024-01-01T00:00:00Z",
  "duedAt": "2024-01-01T00:00:00Z",
  "timezone": "string",
  "color": "string",
  "cover": "string",
  "commentCount": 0,
  "checklistCount": 0,
  "checklistCompletedCount": 0,
  "isRepeating": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "todoList": {
    "id": "string",
    "title": "string"
  },
  "users": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string"
    }
  ],
  "tags": [
    {
      "id": "string",
      "title": "string",
      "color": "string"
    }
  ],
  "checklists": [
    {
      "id": "string",
      "title": "string",
      "position": 0,
      "checklistItems": [
        {
          "id": "string",
          "title": "string",
          "done": true,
          "position": 0,
          "startedAt": "2024-01-01T00:00:00Z",
          "duedAt": "2024-01-01T00:00:00Z"
        }
      ]
    }
  ],
  "customFields": [
    {
      "id": "string",
      "name": "string",
      "type": "CHECKBOX",
      "text": "string",
      "number": 0,
      "checked": true,
      "customFieldOptions": [
        {
          "id": "string",
          "title": "string",
          "color": "string"
        }
      ],
      "tableColumns": {},
      "tableRows": [
        {
          "position": 0,
          "cells": {}
        }
      ],
      "tableTotals": {}
    }
  ]
}

Example

curl -X POST https://rest.blue.app/v1/get-record \
  -H "Authorization: Bearer $BLUE_TOKEN" \
  -H "blue-org-id: $BLUE_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"string","recordId":"string"}'