List Database Records

POST /v1/list-database-records

List the records in one database, with a canonical app URL and every mounted field’s current value. Use list-database-fields first to know what each field id means. Paginate with the returned nextCursor as the next call’s cursor.

Request body

Field	Type	Required	Description
`workspaceId`	string	Yes	The workspace ID
`databaseId`	string	Yes	The database ID (from list-databases)
`first`	number	No	Page size, max 200 (default 50)
`cursor`	string	No	Opaque cursor from a previous call’s nextCursor
`includeArchived`	boolean	No	Include records archived in this database (default false)

{
  "workspaceId": "string",
  "databaseId": "string",
  "first": 0,
  "cursor": "string",
  "includeArchived": true
}

Response

{
  "rows": [
    {
      "record": {
        "id": "string",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      },
      "databaseId": "string",
      "membership": {
        "archived": true,
        "pinned": true,
        "editable": true
      },
      "fields": [
        {
          "id": "string",
          "name": "string",
          "type": "CHECKBOX",
          "value": {},
          "editable": true
        }
      ],
      "url": "string"
    }
  ],
  "nextCursor": "string",
  "hasMore": true
}

Example

curl -X POST https://rest.blue.app/v1/list-database-records \
  -H "Authorization: Bearer $BLUE_TOKEN" \
  -H "blue-org-id: $BLUE_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"string","databaseId":"string","first":0,"cursor":"string","includeArchived":true}'