Skip to content
Management API Reference

Lists SQL snippets for the logged in user

get/v1/snippets

OAuth scopes

  • database: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

  • 200
  • 401
  • 403
  • 429
  • 500

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
}