Skip to content
hydrate.sh droplet markhydrate.sh

List the caller's working branches on a project

GET
/v1/projects/{project_id}/branches
curl --request GET \
  --url https://api.hydrate.sh/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/branches \
  --header 'Authorization: Bearer <token>'

List your active working branches on this project. The protected main branch is not included. Each branch is a unit of work you can read and apply changes to before merging into main.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id

The project to list branches for.

string format: uuid

The project to list branches for.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
BranchListResponse
object
branches
required
Branches
Array<object>
BranchMeta
object
base_main_version
required
Base Main Version
integer
created_at
required
Created At
string
id
required
Id
string format: uuid
is_main
required
Is Main
boolean
last_active_at
required
Last Active At
string
merged_at
required
Any of:
string
name
required
Name
string
owner_id
required
Any of:
string format: uuid
project_id
required
Project Id
string format: uuid
status
required
Status
string
version
required
Version
integer
project_id
required
Project Id
string format: uuid
version
required
Version
string
Examplegenerated
{
  "branches": [
    {
      "base_main_version": 1,
      "created_at": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "is_main": true,
      "last_active_at": "example",
      "merged_at": "example",
      "name": "example",
      "owner_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "status": "example",
      "version": 1
    }
  ],
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "version": "example"
}

401

Section titled “401”

No credentials, malformed credentials, or revoked credentials. The envelope is leak-parity (same shape across all 401 paths) so an attacker cannot distinguish revoked vs. unknown via the body.

Media typeapplication/json
object
detail
required
string
Example
{
  "detail": "unauthenticated"
}

403

Section titled “403”

Credentials are valid but lack the scope required for this route, or the principal lacks membership in the target project.

Media typeapplication/json
object
detail
object
code
string
message
string
Examplegenerated
{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404”

Resource not found OR not accessible to this principal. Leak parity: the response is identical in both cases so an attacker cannot enumerate resources via 404-vs-403 timing.

Media typeapplication/json
object
detail
object
code
string
message
string
Example
{
  "detail": {
    "code": "not_found"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

429

Section titled “429”

Per-bucket rate limit exceeded. The response carries Retry-After and the standard X-RateLimit-* headers (Limit / Remaining / Reset).

Media typeapplication/json
object
detail
string
Example
{
  "detail": "rate_limited"
}

Headers

Section titled “Headers”
Retry-After
integer
X-RateLimit-Limit
integer
X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer