Skip to main content
GET
/
list_workbooks
List workbooks and their saved flows
curl --request GET \
  --url https://api.gumloop.com/api/v1/list_workbooks \
  --header 'Authorization: Bearer <token>'
{
  "workbooks": [
    {
      "workbook_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "created_ts": "2023-11-07T05:31:56Z",
      "saved_items": [
        {
          "saved_item_id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "created_ts": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Query Parameters

​
user_id
string

The user ID for which to list workbooks. Required if project_id is not provided.

​
project_id
string

The project ID for which to list workbooks. Required if user_id is not provided.

Response

Successful retrieval of workbooks and their saved items

​
workbooks
object[]

List of workbooks and their associated saved flows