GET/projects/{id}/notebooks.json

List Notebooks on a Project

This lets you query the list of notebooks for a project. By default, the actual notebook HTML content is not returned.


Path Params

  • Name
    id
    Type
    string
    required
    Description

Query Params

  • Name
    includeContent
    Type
    boolean
    Description
    You can pass includeContent=true to return the notebook HTML content with the notebook data

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "project": {
    "notebooks": [
      {
        "project-id": "999",
        "updated-by-userId": "999",
        "read-comments-count": "0",
        "name": "Test notebook",
        "description": "",
        "created-by-userfirstname": "Demo",
        "comments-count": "1",
        "version-id": "999",
        "private": "0",
        "lockdown-id": "",
        "updated-by-userlastname": "User",
        "updated-date": "2014-03-31T11:56:46Z",
        "created-by-userId": "999",
        "created-by-userlastname": "User",
        "category-id": "999",
        "version": "1",
        "user-display-updated-date": "Mon, 31 Mar 2014",
        "user-display-updated-time": "11:56AM",
        "id": "999",
        "nr-comments": "1",
        "updated-by-userfirstname": "Demo",
        "created-date": "2014-03-31T11:56:46Z",
        "locked": "0",
        "category-name": "Demo Notebooks 2"
      }
    ],
    "name": "demo",
    "id": "999"
  }
}