Skip to content
Management API Reference

Gets a specific SQL snippet

get/v1/snippets/{id}

OAuth scopes

  • database:read

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

  • snippets_read

Path parameters

  • id
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
  "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,
  "content": {
    "favorite": true,
    "schema_version": "lorem",
    "sql": "lorem"
  }
}