Database branches
List branches
Authorization
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 |
get/organizations/{organization}/databases/{database}/branches
Path parameters
organizationstring required
The name of the organization the branch belongs to
databasestring required
The name of the database the branch belongs to
Query parameters
qstring
Search branches by name
productionboolean
Filter branches by production status
safe_migrationsboolean
Filter branches by safe migrations (DDL protection)
order'asc' | 'desc'
Order branches by created_at time
pagenumber
If provided, specifies the page offset of returned results
per_pagenumber
If provided, specifies the number of returned results
Response
Returns database branches