Skip to main content
GET
Get Branches
Returns a JSON array of branch rows. Each row includes the branch’s metadata (id, name, status, created_at, and more) plus branch_url and the pooled URL fields when available. Use this to populate internal dashboards or cleanup tools. For shell scripts that only need a URL, the CLI is simpler:

Authorizations

Authorization
string
header
required

Ardent API key (sk-ard_live_… / sk-ard_test_…) or a dashboard session token.

Path Parameters

connector_id
string
required

Response

Up to 100 branch rows for the connector. Rows may carry additional columns beyond the documented core.

connector_id
string
required

Connector this branch was created from.

created_at
string
required

When the branch was created.

id
string
required

Branch ID.

name
string
required

Branch name, as given at create.

service_type
string
required

Branched service. postgres for Postgres branches.

status
string
required

Current branch status.

branch_url
string | null

Direct connection URL for the branch; sensitive — use exactly as returned.

last_branch_activity
string | null

Most recent activity on the branch. Null when none has been recorded.

masked_ready_at
string | null

When masked data became ready. Null until then.

pooled_branch_prisma_url
string | null

Prisma-formatted pooled URL; null when the provider has no pooled endpoint.

pooled_branch_url
string | null

Pooled connection URL. Null when the provider has no pooled endpoint.

read_ready_at
string | null

When the branch became ready for reads. Null until then.

write_ready_at
string | null

When the branch became ready for writes. Null until then.