Skip to main content
GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
schema
Get a branch schema
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/schema \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "name": "<string>",
      "html": "<string>",
      "raw": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization
string
required

The name of the organization the branch belongs to

​
database
string
required

The name of the database the branch belongs to

​
branch
string
required

The name of the branch

Query Parameters

​
keyspace
string

Return the schema for a single Vitess keyspace

​
namespace
string

Return the schema for a PostgreSQL catalog namespace in <database>.<schema> format (e.g. public.schema1)

Response

Gets the schema for the branch

​
data
object[]
required