Branches

Get branch

Retrieves details of a specific branch including its latest commit and change requests.

get/api/projects/{projectId}/branches/{branchId}

Request

The document declares no server URL.
Auth
- HTTP bearer
- or HTTP internal
TypeScript
https://skmtc.dev/gorules/apis/gorules-agent-api/docs/api/projects/:projectId/branches/:branchId/get.ts
A function with typed inputs. Its response is checked against the schema.

projectIdstring uuid required

Project ID

string uuid required

'main' required

Branch ID or "main" for the default branch

Branch details with latest commit and change requests

idstring uuid required

Branch ID

namestring required

Branch name

defaultboolean required

Whether this is the default (main) branch

projectIdstring uuid required

Project ID

baseCommitIdstring uuid nullable required

Base commit ID

createdByIdstring uuid nullable required

ID of user who created the branch

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

totalCommitsnumber required

Total number of commits on the branch

No recorded changes to this operation across all 1 revision of this API.