StudioHomepage
ServicesCatalogHTTP APIBranches

List branches

GET
/api/catalog/projects/{project_id}/branches

List the live branches of the project. To include deleted branches, set includeDeleted. Branches are in order of name and identity. When branches change during a listing, a branch can be skipped or repeated. Each page token keeps includeDeleted and the scope of the first request. You must have permission to list branches.

This operation returns results in pages. To get the next page, send the nextPageToken value of the response as pageToken in a new request with the same parameters. When the response has no nextPageToken, there are no more pages. A page can have an empty branches list before the last page.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Path Parameters

project_id*string

Owning project identifier. Nonempty, at most 128 UTF-8 bytes, with no control characters. Project creation belongs to the project service.

Query Parameters

includeDeleted?boolean|null
pageSize?|null
pageToken?|null

Response Body

Success

application/json
  1. response

Live branches ordered by name, then stable identity. Weak consistency: concurrent creates, renames, or deletions can omit or repeat entries across pages. A complete consistent project state uses an immutable commit, not this live reference inventory.

branches*array<>
nextPageToken?|null
curl -X GET 'https://api.spiraldb.dev/api/catalog/projects/string/branches'
{  "branches": [    {      "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",      "createdAtMicros": "string",      "deletedAtMicros": "string",      "headCommitId": "ccbbf3ab-15f4-491f-bfd0-0193cd890679",      "lastBranchEventId": "26c3ae27-e158-44c2-95aa-45b0c7e8349c",      "name": "string"    }  ],  "nextPageToken": "string"}