Notebooks
For instructions on how to authenticate to use this endpoint, see API overview.
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
GET | |
GET |
List all notebooks
Required API key scopes
notebook:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- containsstring
Filter for notebooks that match a provided filter. Each match pair is separated by a colon, multiple match pairs can be sent separated by a space or a comma
- created_byinteger
The UUID of the Notebook's creator
- date_fromstring
Filter for notebooks created after this date & time
- date_tostring
Filter for notebooks created before this date & time
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- userstring
If any value is provided for this parameter, return notebooks created by the logged in user.
Response
Example request
GET
/api /projects /:project_id /notebooks
Example response
Status 200
Create notebooks
Required API key scopes
notebook:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- titlestring
- content
- text_contentstring
- versioninteger
- deletedboolean
- _create_in_folderstring
Response
Example request
POST
/api /projects /:project_id /notebooks
Example response
Status 201
Retrieve notebooks
Required API key scopes
notebook:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
- short_idstring
Response
Example request
GET
/api /projects /:project_id /notebooks /:short_id
Example response
Status 200
Update notebooks
Required API key scopes
notebook:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
- short_idstring
Request parameters
- titlestring
- content
- text_contentstring
- versioninteger
- deletedboolean
- _create_in_folderstring
Response
Example request
PATCH
/api /projects /:project_id /notebooks /:short_id
Example response
Status 200
Delete notebooks
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
notebook:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
- short_idstring
Example request
DELETE
/api /projects /:project_id /notebooks /:short_id
Example response
Status 405 No response body
Retrieve notebooks activity retrieve
Required API key scopes
activity_log:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
- short_idstring
Example request
GET
/api /projects /:project_id /notebooks /:short_id /activity
Example response
Status 200 No response body
Retrieve notebooks activity
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET
/api /projects /:project_id /notebooks /activity
Example response
Status 200 No response body
Retrieve notebooks recording comments
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET
/api /projects /:project_id /notebooks /recording_comments