Sign in

v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-branching

Get Branches

Get branch metadata for a connector.

Authorization: User must be authenticated and the connector must belong to an org the user has access to. RLS on branches checks current_user_accessible_connectors.

get/v1/branches/{connector_id}

Path parameters

connector_idstring required

Response

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

idstring required

Branch ID.

namestring required

Branch name, as given at create.

connector_idstring required

Connector this branch was created from.

service_typestring required

Branched service. postgres for Postgres branches.

statusstring required

Current branch status.

created_atstring required

When the branch was created.

last_branch_activitystring nullable

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

read_ready_atstring nullable

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

write_ready_atstring nullable

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

masked_ready_atstring nullable

When masked data became ready. Null until then.

branch_urlstring nullable

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

pooled_branch_urlstring nullable

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

pooled_branch_prisma_urlstring nullable

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