Get all notebooks
GET {{baseUrl}}/api/v1/notebooks
Get all notebooks. This can also be used to search for notebooks with a particular query in the notebook
name or author handle.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
author_handle | string | Return notebooks created by the given author_handle. | |
exclude_author_handle | string | Return notebooks not created by the given author_handle. | |
start | number | The index of the first notebook you want returned. | |
count | number | The number of notebooks to be returned. | |
sort_field | string | Sort by field modified, name, or created. | |
sort_dir | string | Sort by direction asc or desc. | |
query | string | Return only notebooks with query string in notebook name or author handle. | |
include_cells | boolean | Value of false excludes the cells and global time for each notebook. | |
is_template | boolean | True value returns only template notebooks. Default is false (returns only non-template notebooks). | |
type | string | If type is provided, returns only notebooks with that metadata type. Default does not have type filtering. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":123456,"type":"notebooks","attributes":{"name":"Example Notebook","author":{"created_at":"2011-12-12T10:52:03.592Z","disabled":true,"email":"sunt sint Excepteur","handle":"te","icon":"cillum aliqua","name":"in","status":"est nisi la","title":"officia tempor","verified":true},"cells":[{"id":"abcd1234","type":"notebook_cells","attributes":{"definition":{"type":"markdown","text":"# Example Header \nexample content"}}},{"id":"abcd1234","type":"notebook_cells","attributes":{"definition":{"type":"markdown","text":"# Example Header \nexample content"}}}],"created":"2021-02-24T23:14:15.173964+00:00","metadata":{"is_template":false,"take_snapshots":false,"type":"investigation"},"modified":"2021-02-24T23:15:23.274966+00:00","status":"published","time":{"live_span":"1h"}}},{"id":123456,"type":"notebooks","attributes":{"name":"Example Notebook","author":{"created_at":"1956-06-22T11:49:27.925Z","disabled":true,"email":"ut ullamco","handle":"magna l","icon":"dolor Lor","name":"velit","status":"mollit laboris ex","title":"consequat eiusmod sit elit","verified":true},"cells":[{"id":"abcd1234","type":"notebook_cells","attributes":{"definition":{"type":"markdown","text":"# Example Header \nexample content"}}},{"id":"abcd1234","type":"notebook_cells","attributes":{"definition":{"type":"markdown","text":"# Example Header \nexample content"}}}],"created":"2021-02-24T23:14:15.173964+00:00","metadata":{"is_template":false,"take_snapshots":false,"type":"investigation"},"modified":"2021-02-24T23:15:23.274966+00:00","status":"published","time":{"live_span":"1h"}}}],"meta":{"page":{"total_count":-13304344,"total_filtered_count":81448508}}}