/projects/{project_id}/branches/{branch_id}Retrieve branch details
Retrieves information about the specified branch.
A branch_id value has a br- prefix.
Each Neon project is initially created with a root and default branch named main.
A project can contain one or more branches.
A parent branch is identified by a parent_id value, which is the id of the parent branch.
For related information, see Manage branches.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
neon branches get <id|name>Parameters
project_idThe Neon project ID
branch_idThe branch ID
Response
200Returned information about the specified branch
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.