Search Records - Blue API

POST /v1/search-records

Search for records by title within a workspace (does not match description/comment content). 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. Check pageInfo.hasNextPage and pass skip to page through results — a search can silently return only the first page otherwise.

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
`done`	boolean	No	Filter by completion status
`archived`	boolean	No	Archive scope: omit/false searches only active (non-archived) records; true searches ONLY archived records (not active + archived combined — there is no “both” option).
`skip`	number	No	Offset for pagination (default: 0)
`limit`	number	No	Maximum results, max 100 (default: 20)

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

Response

{
  "items": [
    {
      "id": "string",
      "uid": "string",
      "title": "string",
      "done": true,
      "archived": true,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "list": {
        "id": "string",
        "title": "string"
      },
      "users": [
        {
          "id": "string",
          "fullName": "string"
        }
      ],
      "tags": [
        {
          "id": "string",
          "title": "string",
          "color": "string"
        }
      ]
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "totalItems": 0
  }
}

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,"skip":0,"limit":0}'