Skip to main content
GET
/
api
/
projects
/
{projectId}
/
branches
/
{branchId}
/
commits
/
{commitId}
Get branch commit
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/branches/{branchId}/commits/{commitId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "files": [
    "<unknown>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
projectId
string<uuid>
required

Project ID

​
branchId
required

Branch ID or "main" for the default branch

​
commitId
required

Commit ID or "base"/"latest" keywords

Query Parameters

​
content
boolean
default:false

Whether to include file content in the response

Response

200 - application/json

The requested commit

The requested commit

​
id
string<uuid>
required

Commit ID

​
message
string | null
required

Commit message

​
branchId
string<uuid>
required

Branch ID

​
projectId
string<uuid>
required

Project ID

​
createdById
string<uuid> | null
required

ID of user who created the commit

​
createdAt
string<date-time>
required

Creation timestamp

​
createdBy
object

User who created the commit

​
files
any[]

Commit files