List notebooks | Management API Reference

List notebooks of a project

get/v2/projects/{ref}/notebooks

Returns a cursor-paginated list of the project notebooks. Notebook bodies are omitted — read a single notebook to get its cells.

OAuth scopes

database:read

The fine-grained token must include the following permissions to access this endpoint:

project_notebooks_read

Path parameters

ref
Required
string
Project ref

Query parameters

page
Optional
object
filter
Optional
object
sort
Optional
enum

Response codes

Response (200)

1
{
2
  "data": [
3
    {
4
      "type": "notebook",
5
      "id": "lorem",
6
      "attributes": {
7
        "name": "lorem",
8
        "description": "lorem",
9
        "favorite": true,
10
        "inserted_at": "lorem",
11
        "updated_at": "lorem",
12
        "owner": {
13
          "id": 42,
14
          "username": "lorem"
15
        },
16
        "updated_by": {
17
          "id": 42,
18
          "username": "lorem"
19
        }
20
      }
21
    }
22
  ],
23
  "links": {
24
    "first": "/v2/projects/{ref}/notebooks?page[size]=10",
25
    "prev": "/v2/projects/{ref}/notebooks?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
26
    "next": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
27
    "last": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
28
  }
29
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "array",
6
      "items": {
7
        "type": "object",
8
        "properties": {
9
          "type": {
10
            "type": "string",
11
            "description": "Resource type.",
12
            "enum": [
13
              "notebook"
14
            ]
15
          },
16
          "id": {
17
            "type": "string"
18
          },
19
          "attributes": {
20
            "type": "object",
21
            "properties": {
22
              "name": {
23
                "type": "string"
24
              },
25
              "description": {
26
                "type": "string",
27
                "nullable": true
28
              },
29
              "favorite": {
30
                "type": "boolean"
31
              },
32
              "inserted_at": {
33
                "type": "string"
34
              },
35
              "updated_at": {
36
                "type": "string"
37
              },
38
              "owner": {
39
                "type": "object",
40
                "properties": {
41
                  "id": {
42
                    "type": "number"
43
                  },
44
                  "username": {
45
                    "type": "string"
46
                  }
47
                },
48
                "required": [
49
                  "id",
50
                  "username"
51
                ],
52
                "description": "User who created the notebook.",
53
                "nullable": true
54
              },
55
              "updated_by": {
56
                "type": "object",
57
                "properties": {
58
                  "id": {
59
                    "type": "number"
60
                  },
61
                  "username": {
62
                    "type": "string"
63
                  }
64
                },
65
                "required": [
66
                  "id",
67
                  "username"
68
                ],
69
                "description": "User who last wrote to the notebook.",
70
                "nullable": true
71
              }
72
            },
73
            "required": [
74
              "name",
75
              "description",
76
              "favorite",
77
              "inserted_at",
78
              "updated_at",
79
              "owner",
80
              "updated_by"
81
            ]
82
          }
83
        },
84
        "required": [
85
          "type",
86
          "id",
87
          "attributes"
88
        ]
89
      }
90
    },
91
    "links": {
92
      "type": "object",
93
      "properties": {
94
        "first": {
95
          "type": "string",
96
          "description": "URL path to the first page if available.",
97
          "example": "/v2/projects/{ref}/notebooks?page[size]=10",
98
          "nullable": true
99
        },
100
        "prev": {
101
          "type": "string",
102
          "description": "URL path to the previous page.",
103
          "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
104
          "nullable": true
105
        },
106
        "next": {
107
          "type": "string",
108
          "description": "URL path to the next page.",
109
          "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
110
          "nullable": true
111
        },
112
        "last": {
113
          "type": "string",
114
          "description": "URL path to the last page if available.",
115
          "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295",
116
          "nullable": true
117
        }
118
      },
119
      "required": [
120
        "prev",
121
        "next"
122
      ]
123
    }
124
  },
125
  "required": [
126
    "data",
127
    "links"
128
  ]
129
}