Skip to main content
GET
/
api
/
public
/
v2
/
tables
/
{table_id}
/
sheets
List Sheets
curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": 123,
      "title": "<string>",
      "index": 123,
      "row_count": 123,
      "version_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}
List sheets in a Table using cursor pagination. Results are sorted by sheet index; use order=asc or order=desc to control direction.

​
Filtering

Only active sheets are returned. You can also filter sheets by prompt_id, prompt_version_id, or prompt_label_id when you need sheets that contain matching prompt columns.

​
Response shape

Sheets are returned in data with resolved row_count. Pagination metadata is returned in pagination, including next_cursor, has_more, and limit. Applied filters are returned in filters, and count is the number of sheets returned on the current page. 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.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
table_id
string<uuid>
required

Query Parameters

​
cursor
string
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
order
enum<string>
default:asc
Available options:
asc,
desc
​
prompt_id
integer
​
prompt_version_id
integer
​
prompt_label_id
integer

Response

List of sheets

​
data
object[]
​
next_cursor
string | null
​
has_more
boolean