PgBeam Docs
Branches

List sandbox branches

GET
/v1/projects/{project_id}/branches

Lists ephemeral sandbox branches for the project's databases.

Authorization

AuthorizationBearer <token>

JWT issued by Better Auth. Verified via JWKS.

In: header

Path Parameters

project_id*string

Unique project identifier (prefixed, e.g. prj_xxx).

Query Parameters

status?string

Filter to a single status.

page_size?integer

Maximum number of items to return (1-100, default 20).

page_token?string

Opaque token for cursor-based pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/projects/string/branches"
{  "branches": [    {      "id": "brn_01h455vb4pex5vsknk084sn02q",      "database_id": "string",      "credential_id": "string",      "session_id": "string",      "branch_name": "string",      "status": "pending",      "error": "string",      "created_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "discarded_at": "2019-08-24T14:15:22Z"    }  ],  "next_page_token": "string"}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}
{  "error": {    "code": "string",    "message": "string"  }}