A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
Service Token Accesses
read_branch
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | read_branches |
| Database | read_branches |
| Branch | read_branch |
Documentation Index
Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
The access token received from the authorization server in the OAuth 2.0 flow.
The name of the organization the branch belongs to
The name of the database the branch belongs to
The name of the branch
If provided, returns results after the specified cursor
If provided, returns results before the specified cursor
If provided, specifies the number of returned results (max 100)
Returns the generated query patterns reports
The response type. Always "list" for paginated responses.
Whether there is a next page of results
Whether there is a previous page of results
The ID of the first object in the current results, or null when there are no results
The ID of the last object in the current results, or null when there are no results