Skip to content
Management API Reference

List all database branches

get/v1/projects/{ref}/branches

Returns all database branches of the specified project.

OAuth scopes

  • environment:read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 500

Response (200)

1
[
2
{
3
"id": "fbdf5a53-161e-4460-98ad-0e39408d8689",
4
"name": "lorem",
5
"project_ref": "lorem",
6
"parent_project_ref": "lorem",
7
"is_default": true,
8
"git_branch": "lorem",
9
"pr_number": 42,
10
"latest_check_run_id": 42,
11
"persistent": true,
12
"status": "CREATING_PROJECT",
13
"created_at": "2021-12-31T23:34:00Z",
14
"updated_at": "2021-12-31T23:34:00Z",
15
"review_requested_at": "2021-12-31T23:34:00Z",
16
"with_data": true,
17
"notify_url": "https://github.com/NeuraLegion/brokencrystals",
18
"deletion_scheduled_at": "2021-12-31T23:34:00Z",
19
"preview_project_status": "INACTIVE"
20
}
21
]