List Rows

Page through a report’s rows and the document behind each one.

GET /api/v1/reports/{report_id}/rows

cURL

curl "https://api.wordsmith.ai/api/v1/reports/4d845617-3fad-483d-8eac-eba886e6e31f/rows" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "items": [
    {
      "id": "cbe87a67-8eb8-4811-a825-4b0b30c7e013",
      "file_id": "5fd5db90-5cd3-46b6-87d9-c828732551ef",
      "name": "Lease - Unit 9 Riverside Park.pdf"
    },
    {
      "id": "8933f41c-ede7-462e-b985-8c95e261db1f",
      "file_id": "7a2c9e41-0b3d-4f58-a6e2-91c4d7b3e0f5",
      "name": "Lease - 41 High Street.docx"
    }
  ],
  "cursor": null
}

Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.

Returns a page of a report’s rows in display order. Each row names its document: file_id is the file the row’s cells are computed from, and name is its file name. Use it to tell which document a cell from List Cells belongs to.

Authentication

Requires an API key, or an OAuth token with reports:read. Reading a row’s file needs files:read.

Path parameters

report_id · string · required

The report id.

Query parameters

cursor · string

The cursor from the previous page. Leave it out for the first page.

limit · integer · default: "100"

Rows per page, from 1 to 500. Keep it the same for every page of a walk.

Response

Returns 200 with a page of rows. cursor is null on the last page. file_id and name are null for a row with no document, such as one added empty in the app.

cURL

curl "https://api.wordsmith.ai/api/v1/reports/4d845617-3fad-483d-8eac-eba886e6e31f/rows" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "items": [
    {
      "id": "cbe87a67-8eb8-4811-a825-4b0b30c7e013",
      "file_id": "5fd5db90-5cd3-46b6-87d9-c828732551ef",
      "name": "Lease - Unit 9 Riverside Park.pdf"
    },
    {
      "id": "8933f41c-ede7-462e-b985-8c95e261db1f",
      "file_id": "7a2c9e41-0b3d-4f58-a6e2-91c4d7b3e0f5",
      "name": "Lease - 41 High Street.docx"
    }
  ],
  "cursor": null
}

Errors

Status	error_code	When
400	bad_request	cursor is not one this endpoint issued, or limit changed mid-walk.
400	invalid_request_body	limit is not an integer from 1 to 500.
404	resource_not_found	No report with this id, or the caller cannot read it.