Skip to main content
GET
/
api
/
public
/
v2
/
tables
/
{table_id}
/
sheets
/
{sheet_id}
/
rows
List Rows
curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/rows \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "row_index": 123,
      "cells": {}
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "row_count": 123,
  "columns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sheet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": 123,
      "title": "<string>",
      "config": {},
      "position_rank": 123,
      "is_output_column": true
    }
  ],
  "version": 123,
  "execution_metadata_aggregates": {
    "by_column_id": {},
    "sheet": {
      "by_metric": {}
    }
  }
}
Retrieve rows from a Table sheet using cursor pagination. Results are sorted by row_index; use order=asc or order=desc to control direction. Rows are returned as objects with row_index and cells. The cells object is keyed by column ID, and each cell uses column_id in the public payload. Rows are returned in data. Pagination metadata is returned in pagination, including next_cursor, has_more, and limit. Treat next_cursor as opaque. It includes the current sort, order, cursor value, and a hash of the active filters. Reuse a cursor only with the same sort, order, and filter parameters from the request that produced it; changing any of those while passing an old cursor returns an invalid cursor error.

​
Columns

Column definitions are included on the first page by default. Later cursor pages return an empty columns array unless you pass include_columns=true.

​
Row count

row_count is included by default. Pass include_row_count=false when you only need page data.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
table_id
string<uuid>
required
​
sheet_id
string<uuid>
required

Query Parameters

​
include_system_columns
boolean
default:false

When true, include system-managed metadata columns such as price and latency columns for prompt-template outputs.

​
include_execution_metadata_aggregates
boolean
default:false

When true, include sheet-level and per-column aggregates for execution metrics such as price and latency.

​
cursor
string
​
limit
integer
default:100
Required range: 1 <= x <= 100
​
order
enum<string>
default:asc
Available options:
asc,
desc
​
include_columns
boolean

Include column metadata in the response. Defaults to true on the first page.

​
include_row_count
boolean
default:true

Response

List of rows

​
data
object[]

Each item represents one row.

​
next_cursor
string | null
​
has_more
boolean
​
row_count
integer
​
columns
object[]
​
version
integer

Current sheet version_count for this response. It matches the sheet's version_count after any committed changes.

​
execution_metadata_aggregates
object

Sheet-level and per-column aggregates for price and latency metrics. Only present when include_execution_metadata_aggregates=true.