---
title: "Read a page or JSON pointer from a large result already returned by a Hive operation. Uses the same OAuth person, workspace and connection; rechecks the original operation’s scope, permissions, plan, privacy and account grants. Never repeats the original action. Concatenate json pages using nextOffset before parsing."
method: POST
path: "/api/v1/tools/read_workspace_result"
---

# Read a page or JSON pointer from a large result already returned by a Hive operation. Uses the same OAuth person, workspace and connection; rechecks the original operation’s scope, permissions, plan, privacy and account grants. Never repeats the original action. Concatenate json pages using nextOffset before parsing.

`POST /api/v1/tools/read_workspace_result`

## Request

- Base URL: `https://hivepublish.com`
- URL: `https://hivepublish.com/api/v1/tools/read_workspace_result`
- Auth: HTTP bearer

## Request body

- object
  - `resultId` string, required: The temporary resultId returned by the original operation.
  - `pointer` string: Optional JSON pointer such as /report/rows/0; empty text selects the entire result.
  - `offset` integer: Character offset from the previous page’s nextOffset; defaults to 0.
  - `limit` integer: Maximum UTF-16 characters in the JSON text page, from 1 to 16000.
  - `download` boolean: Return a private expiring link to the complete sanitized JSON result instead of a page.

## Response `200`

Tool result

- ToolResult
  - `data` unknown, required
  - `meta` object, required
    - `tool` string
    - `workspaceId` string, uuid

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid credential
- `403`: Missing workspace scope, role permission, or plan entitlement
- `409`: Idempotency conflict, replay, or request still in progress
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/hivepublish/apis/hive-developer-api.md) · [All operations](https://skmtc.dev/hivepublish/apis/hive-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hivepublish/apis/hive-developer-api/revisions/b440c763583e?raw)
