state query parameter. To retrieve pull requests that are
in one of multiple states, repeat the state parameter for each
individual state.
This endpoint also supports filtering and sorting of the results. See
filtering and sorting for more details.
External DocumentationTo learn more, visit the Bitbucket documentation.
Parameters
| Parameter | Description |
|---|---|
| Repo Slug | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}. |
| State | Only return pull requests that are in this state. |
| Workspace Slug | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}. |
Example Output
{
"values": [
{
"comment_count": 1,
"task_count": 1,
"type": "<string>",
"id": 200,
"title": "<string>",
"description": "<string>",
"state": "<string>",
"merge_commit": null,
"close_source_branch": false,
"closed_by": null,
"author": {
"display_name": "<string>",
"links": {
"self": {
"href": "<string>"
},
"avatar": {
"href": "<string>"
},
"html": {
"href": "<string>"
}
},
"type": "<string>",
"uuid": "<string>",
"account_id": "<string>",
"nickname": "<string>"
},
"reason": "<string>",
"created_on": "2025-04-06T08:43:32.831168+00:00",
"updated_on": "2025-04-06T08:43:33.717193+00:00",
"destination": {
"branch": {
"name": "<string>"
},
"commit": {
"hash": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
}
},
"type": "<string>"
},
"repository": {
"type": "<string>",
"full_name": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"avatar": {
"href": "<string>"
}
},
"name": "<string>",
"uuid": "<string>"
}
},
"source": {
"branch": {
"name": "<string>",
"links": {}
},
"commit": {
"hash": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
}
},
"type": "<string>"
},
"repository": {
"type": "<string>",
"full_name": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"avatar": {
"href": "<string>"
}
},
"name": "<string>",
"uuid": "<string>"
}
},
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"commits": {
"href": "<string>"
},
"approve": {
"href": "<string>"
},
"request-changes": {
"href": "<string>"
},
"diff": {
"href": "<string>"
},
"diffstat": {
"href": "<string>"
},
"comments": {
"href": "<string>"
},
"activity": {
"href": "<string>"
},
"merge": {
"href": "<string>"
},
"decline": {
"href": "<string>"
},
"statuses": {
"href": "<string>"
}
},
"summary": {
"type": "<string>",
"raw": "<string>",
"markup": "<string>",
"html": "<string>"
},
"draft": false
},
{
"comment_count": 1,
"task_count": 0,
"type": "<string>",
"id": 137,
"title": "<string>",
"description": "<string>",
"state": "<string>",
"merge_commit": null,
"close_source_branch": true,
"closed_by": null,
"author": {
"display_name": "<string>",
"links": {
"self": {
"href": "<string>"
},
"avatar": {
"href": "<string>"
},
"html": {
"href": "<string>"
}
},
"type": "<string>",
"uuid": "<string>",
"account_id": "<string>",
"nickname": "<string>"
},
"reason": "<string>",
"created_on": "2025-04-06T08:43:32.831168+00:00",
"updated_on": "2025-04-06T08:43:33.717193+00:00",
"destination": {
"branch": {
"name": "<string>"
},
"commit": {
"hash": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
}
},
"type": "<string>"
},
"repository": {
"type": "<string>",
"full_name": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"avatar": {
"href": "<string>"
}
},
"name": "<string>",
"uuid": "<string>"
}
},
"source": {
"branch": {
"name": "<string>",
"links": {}
},
"commit": {
"hash": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
}
},
"type": "<string>"
},
"repository": {
"type": "<string>",
"full_name": "<string>",
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"avatar": {
"href": "<string>"
}
},
"name": "<string>",
"uuid": "<string>"
}
},
"links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"commits": {
"href": "<string>"
},
"approve": {
"href": "<string>"
},
"request-changes": {
"href": "<string>"
},
"diff": {
"href": "<string>"
},
"diffstat": {
"href": "<string>"
},
"comments": {
"href": "<string>"
},
"activity": {
"href": "<string>"
},
"merge": {
"href": "<string>"
},
"decline": {
"href": "<string>"
},
"statuses": {
"href": "<string>"
}
},
"summary": {
"type": "<string>",
"raw": "<string>",
"markup": "<string>",
"html": "<string>"
},
"draft": false
}
],
"pagelen": 85,
"size": 3,
"page": 1
}
Workflow Library Example
List Pull Requests with Bitbucket and Send Results Via Email