GET
/
v1
/
workbooks
import Grid from '@grid-is/api';

const client = new Grid({
  apiKey: process.env['GRID_API_TOKEN'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const workbookListResponse of client.workbooks.list()) {
    console.log(workbookListResponse.id);
  }
}

main();
{
  "pagination": {
    "next_cursor": "<string>"
  },
  "items": [
    {
      "id": "<string>",
      "filename": "<string>",
      "state": "processing",
      "defect": "",
      "version": 123,
      "latest_ready_version": 123,
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:25

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
application/json

Successful Response

The response is of type object.