StudioHomepage
ServicesCatalogHTTP APIBranch history

List the events of a branch

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

List the events of one branch, newest first. This operation also works for a deleted branch. The first page sets the newest event of the listing. You must have permission to read the branch history of the project.

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 events 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.

branch_id*string

Stable UUIDv7 branch identity. Rename preserves identity; deletion tombstones it.

Formatuuid

Query Parameters

pageSize?|null
pageToken?|null

Response Body

Success

application/json
  1. response

Events follow the stable branch event chain newest first. Branch metadata is captured with the first-page frontier and retained for that traversal; deleted branches remain inspectable.

branchId*catalog.BranchId

Stable UUIDv7 branch identity. Rename preserves identity; deletion tombstones it.

Formatuuid
currentName?|null
deletedAtMicros?||null
events*array<>
nextPageToken?|null
curl -X GET 'https://api.spiraldb.dev/api/catalog/projects/string/branches/497f6eca-6276-4993-bfeb-53cbbbba6f08/events'
{  "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",  "currentName": "string",  "deletedAtMicros": "string",  "events": [    {      "actor": "string",      "branchEventId": "652c6cb3-38b8-46ef-8926-780723491e40",      "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",      "message": "string",      "newCommitId": "13517670-88c3-4c6a-a869-3a07050599df",      "newName": "string",      "occurredAtMicros": "string",      "oldCommitId": "bf8dd278-3b22-4584-82a5-b50b07acd157",      "oldName": "string",      "operation": "create",      "previousBranchEventId": "bc9045a0-48a1-4c4c-87b2-295e480fbf76",      "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"    }  ],  "nextPageToken": "string"}