API Documentation

Pull requests

List tags

Returns the pull requests from the Github project.

Required scopes: WORKSPACE, REPOSITORY_READ

Resource URL
GET /workspaces/:domain/projects/:project_name/repository/pulls
URL Parameters
Name Description
domain Required String The workspace domain.
project_name Required String The name ID of the project.
Example
Request
GET https://api.buddy.works/workspaces/buddy/projects/company-website/repository/pulls
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/pulls",
  "pull_requests": [
		{
			"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/pulls/3",
			"name": "pull/3",
			"github_html_url": "https://github.com/orgs/buddy-works/pull-request-repo/pull/3"
		}
  ]
}

Get

Returns the information on the desired pull request.

Required scopes: WORKSPACE, REPOSITORY_READ

Resource URL
GET /workspaces/:domain/projects/:project_name/repository/pulls/:number
URL Parameters
Name Description
domain Required String The workspace domain.
name Required String The name of the tag.
project_name Required String The name ID of the project.
Example
Request
GET https://api.buddy.works/workspaces/buddy/projects/company-website/repository/pulls/1
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
	"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/pulls/3",
	"name": "pull/3",
	"github_html_url": "https://github.com/orgs/buddy-works/pull-request-repo/pull/3"
}

Get started now

14 days of unlimited trial. No credit card required.