List

Returns a list of commits in the repository.

Required scopes: WORKSPACE, REPOSITORY_READ

Resource URL

GET /workspaces/:domain/projects/:project_name/repository/commits

URL Parameters

Name	Type	Description
domain `Required`	String	The workspace domain.
project_name `Required`	String	The name ID of the project.

GET Parameters

Name	Type	Description
author	String	Filters the commits by their author.
page	Integer	The number of the successive page (results are splitted by pages of `per_page` elements each).
path	String	Filters the commits by contained changes to the path.
per_page	Integer	The number of returned elements on the page.
revision	String	SHA or branch/tag to start listing commits from. Default: the repository’s default branch (usually master).
since	ISO 8601 Date in GMT	Only commits after this date will be returned.
until	ISO 8601 Date in GMT	Only commits before this date will be returned.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits?since=2016-01-01T00%3a00%3a00Z&until=2016-01-31T00%3a00%3a00Z&page=1&per_page=2

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits",
  "html_url": "https://app.buddy.works/buddy/company-website/repository/commits",
  "commits": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits/506a3963507943d6908154f4bc9646e829128a08",
      "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/506a3963507943d6908154f4bc9646e829128a08",
      "revision": "506a3963507943d6908154f4bc9646e829128a08",
      "author_date": "2016-01-19T12:36:33Z",
      "commit_date": "2016-01-19T12:36:33Z",
      "message": "init repo\n",
      "committer": {
        "url": "https://api.buddy.works/workspaces/buddy/member/1",
        "html_url": "https://app.buddy.works/buddy/profile/1",
        "id": 1,
        "name": "Mike Benson",
        "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png"
      },
      "author": {
        "url": "https://api.buddy.works/workspaces/buddy/member/1",
        "html_url": "https://app.buddy.works/buddy/profile/1",
        "id": 1,
        "name": "Mike Benson",
        "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png"
      }
    }
  ]
}

Last modified on April 26, 2022

List

Knowledge is power!