Search Records - Blue API

POST /v1/search-records

Full-text search for records by name/content within a workspace. This is the right tool to find records in large workspaces — it queries the backend directly rather than filtering a loaded page, so it finds matches list-records would never page to. Returns a summary view; use get-record for full detail.

Request body

Field	Type	Required	Description
`workspaceId`	string	Yes	Workspace ID or slug to search within
`query`	string	Yes	Search text to match against record titles and content
`done`	boolean	No	Filter by completion status
`archived`	boolean	No	Include archived records. Defaults to false (excludes archived).
`limit`	number	No	Maximum results, max 100 (default: 20)

{
  "workspaceId": "string",
  "query": "string",
  "done": true,
  "archived": true,
  "limit": 0
}

Response

[
  {
    "id": "string",
    "uid": "string",
    "title": "string",
    "done": true,
    "archived": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z",
    "todoList": {
      "id": "string",
      "title": "string"
    },
    "users": [
      {
        "id": "string",
        "fullName": "string"
      }
    ],
    "tags": [
      {
        "id": "string",
        "title": "string",
        "color": "string"
      }
    ]
  }
]

Example

curl -X POST https://rest.blue.app/v1/search-records \
  -H "Authorization: Bearer $BLUE_TOKEN" \
  -H "blue-org-id: $BLUE_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"string","query":"string","done":true,"archived":true,"limit":0}'