Skip to content
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

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "data": [
    {
      "id": "lorem",
      "inserted_at": "lorem",
      "updated_at": "lorem",
      "type": "sql",
      "visibility": "user",
      "name": "lorem",
      "description": "lorem",
      "project": {
        "id": 42,
        "name": "lorem"
      },
      "owner": {
        "id": 42,
        "username": "lorem"
      },
      "updated_by": {
        "id": 42,
        "username": "lorem"
      },
      "favorite": true
    }
  ],
  "cursor": "lorem"
}