---
title: "List workbooks"
method: GET
path: "/v1/workbooks"
tags: ["workbooks"]
---

# List workbooks

`GET /v1/workbooks`

List the workbooks linked to an account.

This endpoint returns a paginated list of workbooks.

## Query parameters

- `limit` integer — Number of items to return per page
- `cursor` string — Cursor for the next page of items. If not provided, the first batch of items will be returned.

## Response `200`

Successful Response

- WorkbookListResponse
  - `pagination` Pagination, required
    - `next_cursor` string, nullable — The cursor to pass on as query parameter for the next batch of items, if any
  - `items` WorkbookItem[], required
    - `id` string, required — A workbook's unique identifier
    - `filename` string, required — The original filename of the uploaded workbook
    - `state` 'processing' | 'ready' | 'error', required — The state of a workbook. If the state is `processing`, the workbook is not yet ready to query. If the state is `error`, the workbook has encountered an error during processing. An explanation of the error can be found in the `defect` field.
    - `defect` '' | 'too_big' | 'converted_workbook_too_big' | 'unrecognized_format' | 'cannot_fetch_from_remote' | 'processing_timeout' | 'conversion_error', required — Problems that may be found when processing a workbook.
    - `version` integer, required — The most recent version of the workbook
    - `latest_ready_version` integer, nullable — The latest version of the workbook that has a 'ready' state
    - `created` string, date-time, required — The date/time the workbook was created
    - `modified` string, date-time, required — The date/time the workbook was last modified

## Other responses

- `400` — Error returned when you make a bad request
- `403` — Error returned when you don't have permission to query a workbook
- `429` — Error returned when you exceed your API rate limit

---

[API](https://skmtc.net/grid-is/apis/grid-api.md) · [All operations](https://skmtc.net/grid-is/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/grid-is/grid-api/versions/2f55490ab23d/schema)