Skip to content

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"
}
}
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"inserted_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"sql"
]
},
"visibility": {
"type": "string",
"enum": [
"user",
"project",
"org",
"public"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"project": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
]
},
"updated_by": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
]
},
"favorite": {
"type": "boolean"
},
"content": {
"type": "object",
"properties": {
"favorite": {
"deprecated": true,
"description": "Deprecated: Rely on root-level favorite property instead.",
"type": "boolean"
},
"schema_version": {
"type": "string"
},
"sql": {
"type": "string"
}
},
"required": [
"sql"
]
}
},
"required": [
"id",
"inserted_at",
"updated_at",
"type",
"visibility",
"name",
"description",
"project",
"owner",
"updated_by",
"favorite",
"content"
]
}