/projects/{project_id}/branchesList branches
Retrieves a list of branches for the specified project.
Each Neon project has a root branch named main.
A branch_id value has a br- prefix.
A project may contain child branches that were branched from main or from another branch.
A parent branch is identified by the 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" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
neon branches listParameters
project_idThe Neon project ID
searchSearch by branch name or id. You can specify partial name or id values to filter results.
sort_bySort the branches by sort_field. If not provided, branches will be sorted by updated_at descending order
cursorA cursor to use in pagination. A cursor defines your place in the data list. Include response.pagination.next in subsequent API calls to fetch next page of the list.
sort_orderDefines the sorting order of entities.
limitThe maximum number of records to be returned in the response
include_deletedIf true, return recoverable deleted branches too (soft-deleted within the recovery window). If false or not provided, return only active (non-deleted) branches.
This parameter is part of the Branch Recovery feature, which is in preview and not available to all users.
Response
200Returned a list of branches for the specified project
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.