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

The fine-grained token must include the following permissions to access this endpoint:

  • branching_development_read
  • or
  • branching_production_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 500

Response (200)

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "lorem",
    "project_ref": "lorem",
    "parent_project_ref": "lorem",
    "is_default": true,
    "git_branch": "lorem",
    "pr_number": -9007199254740991,
    "latest_check_run_id": 42,
    "persistent": true,
    "status": "CREATING_PROJECT",
    "created_at": "4404-02-29T04:24Z",
    "updated_at": "4404-02-29T04:24Z",
    "review_requested_at": "4404-02-29T04:24Z",
    "with_data": true,
    "notify_url": "https://github.com/NeuraLegion/brokencrystals",
    "deletion_scheduled_at": "4404-02-29T04:24Z",
    "preview_project_status": "INACTIVE"
  }
]