List all snippets | Management API Reference

Lists SQL snippets for the logged in user

get/v1/snippets

OAuth scopes

database:read

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

snippets_read

Query parameters

project_ref
Optional
string
Project ref
cursor
Optional
string
limit
Optional
string
sort_by
Optional
enum
sort_order
Optional
enum

Response codes

Response (200)

1
{
2
  "data": [
3
    {
4
      "id": "lorem",
5
      "inserted_at": "lorem",
6
      "updated_at": "lorem",
7
      "type": "sql",
8
      "visibility": "user",
9
      "name": "lorem",
10
      "description": "lorem",
11
      "project": {
12
        "id": 42,
13
        "name": "lorem"
14
      },
15
      "owner": {
16
        "id": 42,
17
        "username": "lorem"
18
      },
19
      "updated_by": {
20
        "id": 42,
21
        "username": "lorem"
22
      },
23
      "favorite": true
24
    }
25
  ],
26
  "cursor": "lorem"
27
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "array",
6
      "items": {
7
        "type": "object",
8
        "properties": {
9
          "id": {
10
            "type": "string"
11
          },
12
          "inserted_at": {
13
            "type": "string"
14
          },
15
          "updated_at": {
16
            "type": "string"
17
          },
18
          "type": {
19
            "type": "string",
20
            "enum": [
21
              "sql"
22
            ]
23
          },
24
          "visibility": {
25
            "type": "string",
26
            "enum": [
27
              "user",
28
              "project",
29
              "org",
30
              "public"
31
            ]
32
          },
33
          "name": {
34
            "type": "string"
35
          },
36
          "description": {
37
            "type": "string",
38
            "nullable": true
39
          },
40
          "project": {
41
            "type": "object",
42
            "properties": {
43
              "id": {
44
                "type": "number"
45
              },
46
              "name": {
47
                "type": "string"
48
              }
49
            },
50
            "required": [
51
              "id",
52
              "name"
53
            ]
54
          },
55
          "owner": {
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
          },
70
          "updated_by": {
71
            "type": "object",
72
            "properties": {
73
              "id": {
74
                "type": "number"
75
              },
76
              "username": {
77
                "type": "string"
78
              }
79
            },
80
            "required": [
81
              "id",
82
              "username"
83
            ]
84
          },
85
          "favorite": {
86
            "type": "boolean"
87
          }
88
        },
89
        "required": [
90
          "id",
91
          "inserted_at",
92
          "updated_at",
93
          "type",
94
          "visibility",
95
          "name",
96
          "description",
97
          "project",
98
          "owner",
99
          "updated_by",
100
          "favorite"
101
        ]
102
      }
103
    },
104
    "cursor": {
105
      "type": "string"
106
    }
107
  },
108
  "required": [
109
    "data"
110
  ]
111
}