Skip to main content
GET
/
api
/
projects
/
{projectId}
/
commits
/
{commitId}
/
diff
Get commit diff
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/commits/{commitId}/diff \
  --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",
  "branch": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "default": true,
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "baseCommitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "changeRequests": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>",
        "type": "<string>",
        "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "changes": [
    {
      "file": "<unknown>",
      "from": "<unknown>",
      "to": "<unknown>"
    }
  ],
  "stats": {
    "filesAdded": 123,
    "filesDeleted": 123,
    "filesModified": 123,
    "totalChanges": 123,
    "filesRenamed": 123
  },
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "files": [
    "<unknown>"
  ],
  "previousCommit": {
    "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

​
commitId
string<uuid>
required

Commit ID

Query Parameters

​
content
default:true

Whether to include file content in the response

Available options:
true,
false,
True,
False,
TRUE,
FALSE

Response

200 - application/json

Commit diff with file changes and statistics

Commit diff with file changes and statistics

​
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

​
branch
object
required

Branch the commit belongs to

​
changes
object[] | null
required

List of file changes

​
stats
object
required

Change statistics

​
createdBy
object

User who created the commit

​
files
any[]

Commit files

​
previousCommit
object

Previous commit