Skip to main content
GET
List worksheets
The list only includes worksheets created with the same API user as your access token. Results are newest first.

Filter by your own fields

Any query parameter other than page and page_size filters on the meta_data you sent when starting the worksheet. For example, if you started worksheets with meta_data={"teacher_id": "T-1042"}:
A parameter that doesn’t match a meta_data key returns an empty list, not an error.

Reading progress

current_stage is the latest step that has started, and status is that step’s status:

Authorizations

Authorization
string
header
required

Access token from Get an access token.

Query Parameters

page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
page_size
integer
default:10

Items per page. Maximum 100.

Required range: 1 <= x <= 100

Response

A page of worksheets.

pagination
object
data
object[]