Skip to content
forgit api docs

List commit statuses for a pull request

GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses

Returns all statuses (e.g. build results) for the given pull request.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
pull_request_id
required
integer

The id of the pull request.

repo_slug
required
string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Query Parameters

Section titled “ Query Parameters ”
q
string

Query string to narrow down the response as per filtering and sorting.

sort
string

Field by which the results should be sorted as per filtering and sorting. Defaults to created_on.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

A paginated list of all commit statuses for this pull request.

Media type application/json
Paginated Commit Statuses

A paginated list of commit status objects.

object
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
>= 1
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
>= 1
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
values
Array
0 unique items
object
type
required
string
links
object
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
commit
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
required

An identifier for the status that’s unique to its type (current “build” is the only supported type) and the vendor, e.g. BB-DEPLOY

string
refname

The name of the ref that pointed to this commit at the time the status object was created. Note that this the ref may since have moved off of the commit. This optional field can be useful for build systems whose build triggers and configuration are branch-dependent (e.g. a Pipeline build). It is legitimate for this field to not be set, or even apply (e.g. a static linting job).

string
url

A URL linking back to the vendor or build system, for providing more information about whatever process produced this status. Accepts context variables repository and commit that Bitbucket will evaluate at runtime whenever at runtime. For example, one could use https://foo.com/builds/{repository.full_name} which Bitbucket will turn into https://foo.com/builds/foo/bar at render time.

string
state
required

Provides some indication of the status of this commit

string
Allowed values: FAILED INPROGRESS STOPPED SUCCESSFUL
name

An identifier for the build itself, e.g. BB-DEPLOY-1

string
description

A description of the build (e.g. “Unit tests in Bamboo”)

string
created_on
string format: date-time
updated_on
string format: date-time
Example 
{
  "values": [
    {
      "state": "FAILED"
    }
  ]
}

401

Section titled “ 401 ”

If the repository is private and the request was not authenticated.

404

Section titled “ 404 ”

If the specified repository or pull request does not exist.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}