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, delete_branch, create_branch, connect_production_branch, connect_branch
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | read_branches |
| Database | read_branches |
| Branch | read_branch |
The access token received from the authorization server in the OAuth 2.0 flow.
Organization name slug from list_organizations. Example: acme.
Database name slug from list_databases. Example: app-db.
Search branches by name
Filter branches by production status
Filter branches by safe migrations (DDL protection)
Order branches by created_at time
asc, desc If provided, specifies the page offset of returned results
If provided, specifies the number of returned results
Returns database branches