> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # bitbucket-pullrequests > Pull requests and reviews **Server path:** `/bitbucket-pullrequests` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------- | --------------------------------------- | | [`bitbucket_pullrequests_approve_pull_request`](#bitbucket_pullrequests_approve_pull_request) | Approve a pull request | | [`bitbucket_pullrequests_create_pull_request`](#bitbucket_pullrequests_create_pull_request) | Create a pull request | | [`bitbucket_pullrequests_create_pull_request_comment`](#bitbucket_pullrequests_create_pull_request_comment) | Create a comment on a pull request | | [`bitbucket_pullrequests_decline_pull_request`](#bitbucket_pullrequests_decline_pull_request) | Decline a pull request | | [`bitbucket_pullrequests_delete_pull_request_comment`](#bitbucket_pullrequests_delete_pull_request_comment) | Delete a comment on a pull request | | [`bitbucket_pullrequests_get_pull_request`](#bitbucket_pullrequests_get_pull_request) | Get a pull request | | [`bitbucket_pullrequests_get_pull_request_comment`](#bitbucket_pullrequests_get_pull_request_comment) | Get a comment on a pull request | | [`bitbucket_pullrequests_get_pull_request_diff`](#bitbucket_pullrequests_get_pull_request_diff) | List changes in a pull request | | [`bitbucket_pullrequests_get_pull_request_diffstat`](#bitbucket_pullrequests_get_pull_request_diffstat) | Get the diff stat for a pull request | | [`bitbucket_pullrequests_list_default_reviewers`](#bitbucket_pullrequests_list_default_reviewers) | List default reviewers | | [`bitbucket_pullrequests_list_pull_request_activity`](#bitbucket_pullrequests_list_pull_request_activity) | List a pull request activity log | | [`bitbucket_pullrequests_list_pull_request_comments`](#bitbucket_pullrequests_list_pull_request_comments) | List comments on a pull request | | [`bitbucket_pullrequests_list_pull_request_commits`](#bitbucket_pullrequests_list_pull_request_commits) | List commits on a pull request | | [`bitbucket_pullrequests_list_pull_request_statuses`](#bitbucket_pullrequests_list_pull_request_statuses) | List commit statuses for a pull request | | [`bitbucket_pullrequests_list_pull_requests`](#bitbucket_pullrequests_list_pull_requests) | List pull requests | | [`bitbucket_pullrequests_merge_pull_request`](#bitbucket_pullrequests_merge_pull_request) | Merge a pull request | | [`bitbucket_pullrequests_unapprove_pull_request`](#bitbucket_pullrequests_unapprove_pull_request) | Unapprove a pull request | | [`bitbucket_pullrequests_update_pull_request`](#bitbucket_pullrequests_update_pull_request) | Update a pull request | | [`bitbucket_pullrequests_update_pull_request_comment`](#bitbucket_pullrequests_update_pull_request_comment) | Update a comment on a pull request | *** ## bitbucket\_pullrequests\_approve\_pull\_request Approve a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_create\_pull\_request Create a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `author` | object | No | — | The author value | | `close_source_branch` | boolean | No | — | A boolean flag indicating if merging the pull request closes the source branch. | | `closed_by` | object | No | — | Closed By | | `comment_count` | integer | No | — | The number of comments for a specific pull request. | | `created_on` | string | No | — | The ISO8601 timestamp the request was created. | | `destination` | object | No | — | The destination value | | `draft` | boolean | No | — | A boolean flag indicating whether the pull request is a draft. | | `id` | integer | No | — | The pull request's unique ID. Note that pull request IDs are only unique within their associated repository. | | `links` | object | No | — | The links value | | `merge_commit` | object | No | — | Merge Commit | | `mergeable` | boolean | No | — | A boolean flag indicating whether the pull request passes all merge checks | | `participants` | any\[] | No | — | The list of users that are collaborating on this pull request. Collaborators are user that: \* are added to the pull request as a reviewer (part of the reviewers list) \* are not explicit reviewers, but have commented on the pull request \* are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id. | | `queued` | boolean | No | — | A boolean flag indicating whether the pull request is queued | | `reason` | string | No | — | Explains why a pull request was declined. This field is only applicable to pull requests in rejected state. | | `rendered` | object | No | — | User provided pull request text, interpreted in a markup language and rendered in HTML | | `reviewers` | any\[] | No | — | The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL. | | `source` | object | No | — | The source value | | `state` | string | No | — | The pull request's current status. | | `summary` | object | No | — | The summary value | | `task_count` | integer | No | — | The number of open tasks for a specific pull request. | | `title` | string | No | — | Title of the pull request. | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | The ISO8601 timestamp the request was last updated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "author": { "description": "The author value" }, "close_source_branch": { "type": "boolean", "description": "A boolean flag indicating if merging the pull request closes the source branch." }, "closed_by": { "description": "Closed By" }, "comment_count": { "type": "integer", "description": "The number of comments for a specific pull request." }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the request was created." }, "destination": { "type": "object", "description": "The destination value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "draft": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is a draft." }, "id": { "type": "integer", "description": "The pull request's unique ID. Note that pull request IDs are only unique within their associated repository." }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "approve": { "type": "object", "description": "A link to a resource related to this object." }, "diff": { "type": "object", "description": "A link to a resource related to this object." }, "diffstat": { "type": "object", "description": "A link to a resource related to this object." }, "comments": { "type": "object", "description": "A link to a resource related to this object." }, "activity": { "type": "object", "description": "A link to a resource related to this object." }, "merge": { "type": "object", "description": "A link to a resource related to this object." }, "decline": { "type": "object", "description": "A link to a resource related to this object." } } }, "merge_commit": { "type": "object", "description": "Merge Commit", "properties": { "hash": { "type": "string", "description": "The hash value" } } }, "mergeable": { "type": "boolean", "description": "A boolean flag indicating whether the pull request passes all merge checks" }, "participants": { "type": "array", "description": "The list of users that are collaborating on this pull request. Collaborators are user that: * are added to the pull request as a reviewer (part of the reviewers list) * are not explicit reviewers, but have commented on the pull request * are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id." }, "queued": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is queued" }, "reason": { "type": "string", "description": "Explains why a pull request was declined. This field is only applicable to pull requests in rejected state." }, "rendered": { "type": "object", "description": "User provided pull request text, interpreted in a markup language and rendered in HTML", "properties": { "title": { "type": "object", "description": "The title value" }, "description": { "type": "object", "description": "The description value" }, "reason": { "type": "object", "description": "The reason value" } } }, "reviewers": { "type": "array", "description": "The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL." }, "source": { "type": "object", "description": "The source value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "state": { "type": "string", "description": "The pull request's current status.", "enum": [ "OPEN", "DRAFT", "QUEUED", "MERGED", "DECLINED", "SUPERSEDED" ] }, "summary": { "type": "object", "description": "The summary value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "task_count": { "type": "integer", "description": "The number of open tasks for a specific pull request." }, "title": { "type": "string", "description": "Title of the pull request." }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "The ISO8601 timestamp the request was last updated." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_create\_pull\_request\_comment Create a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `content` | object | No | — | The content value | | `created_on` | string | No | — | Created On | | `deleted` | boolean | No | — | The deleted value | | `id` | integer | No | — | The id value | | `inline` | object | No | — | The inline value | | `links` | object | No | — | The links value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/comment | | `pending` | boolean | No | — | The pending value | | `pullrequest` | object | No | — | The pullrequest value | | `resolution` | object | No | — | The resolution object for a Comment. | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `user` | object | No | — | The user value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "content": { "type": "object", "description": "The content value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "created_on": { "type": "string", "description": "Created On" }, "deleted": { "type": "boolean", "description": "The deleted value" }, "id": { "type": "integer", "description": "The id value" }, "inline": { "type": "object", "description": "The inline value", "properties": { "from": { "type": "integer", "description": "The comment's anchor line in the old version of the file. If the comment is a multi-line comment, this is the ending line number in the old version of the file." }, "to": { "type": "integer", "description": "The comment's anchor line in the new version of the file. If the comment is a multi-line comment, this is the ending line number in the new version of the file." }, "start_from": { "type": "integer", "description": "The starting line number in the old version of the file, if the comment is a multi-line comment. This is null otherwise." }, "start_to": { "type": "integer", "description": "The starting line number in the new version of the file, if the comment is a multi-line comment. This is null otherwise." }, "path": { "type": "string", "description": "The path of the file this comment is anchored to." } }, "required": [ "path" ] }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "code": { "type": "object", "description": "A link to a resource related to this object." } } }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/comment" }, "pending": { "type": "boolean", "description": "The pending value" }, "pullrequest": { "description": "The pullrequest value" }, "resolution": { "type": "object", "description": "The resolution object for a Comment.", "properties": { "type": { "type": "string", "description": "The type value" }, "user": { "description": "The user value" }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the resolution was created." } }, "required": [ "type" ] }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "user": { "description": "The user value" } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace", "type" ] } ``` *** ## bitbucket\_pullrequests\_decline\_pull\_request Decline a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_delete\_pull\_request\_comment Delete a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `comment_id` | integer | Yes | — | The id of the comment. | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "integer", "description": "The id of the comment." }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "comment_id", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request Get a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request\_comment Get a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `comment_id` | integer | Yes | — | The id of the comment. | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "integer", "description": "The id of the comment." }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "comment_id", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request\_diff List changes in a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_get\_pull\_request\_diffstat Get the diff stat for a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_default\_reviewers List default reviewers **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_activity List a pull request activity log **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_comments List comments on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_commits List commits on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_request\_statuses List commit statuses for a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `q` | string | No | — | Query string to narrow down the response as per filtering and sorting. | | `sort` | string | No | — | Field by which the results should be sorted as per filtering and sorting. Defaults to `created_on`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "q": { "type": "string", "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." }, "sort": { "type": "string", "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). Defaults to `created_on`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_list\_pull\_requests List pull requests **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `state` | string | No | — | Only return pull requests that are in this state. This parameter can be repeated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "state": { "type": "string", "description": "Only return pull requests that are in this state. This parameter can be repeated.", "enum": [ "OPEN", "MERGED", "DECLINED", "SUPERSEDED" ] } }, "required": [ "PCID", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_merge\_pull\_request Merge a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `async` | boolean | No | — | Default value is false. When set to true, runs merge asynchronously and immediately returns a 202 with polling link to the task-status API in the Location header. When set to false, runs merge and waits for it to complete, returning 200 when it succeeds. If the duration of the merge exceeds a timeout threshold, the API returns a 202 with polling link to the task-status API in the Location header. | | `close_source_branch` | boolean | No | — | Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False | | `merge_strategy` | string | No | — | The merge strategy that will be used to merge the pull request. | | `message` | string | No | — | The commit message that will be used on the resulting commit. Note that the size of the message is limited to 128 KiB. | | `type` | string | No | — | The type value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "async": { "type": "boolean", "description": "Default value is false. When set to true, runs merge asynchronously and immediately returns a 202 with polling link to the task-status API in the Location header. When set to false, runs merge and waits for it to complete, returning 200 when it succeeds. If the duration of the merge exceeds a timeout threshold, the API returns a 202 with polling link to the task-status API in the Location header." }, "close_source_branch": { "type": "boolean", "description": "Whether the source branch should be deleted. If this is not provided, we fallback to the value used when the pull request was created, which defaults to False" }, "merge_strategy": { "type": "string", "description": "The merge strategy that will be used to merge the pull request.", "enum": [ "merge_commit", "squash", "fast_forward", "squash_fast_forward", "rebase_fast_forward", "rebase_merge" ] }, "message": { "type": "string", "description": "The commit message that will be used on the resulting commit. Note that the size of the message is limited to 128 KiB." }, "type": { "type": "string", "description": "The type value" } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_unapprove\_pull\_request Unapprove a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_update\_pull\_request Update a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `author` | object | No | — | The author value | | `close_source_branch` | boolean | No | — | A boolean flag indicating if merging the pull request closes the source branch. | | `closed_by` | object | No | — | Closed By | | `comment_count` | integer | No | — | The number of comments for a specific pull request. | | `created_on` | string | No | — | The ISO8601 timestamp the request was created. | | `destination` | object | No | — | The destination value | | `draft` | boolean | No | — | A boolean flag indicating whether the pull request is a draft. | | `id` | integer | No | — | The pull request's unique ID. Note that pull request IDs are only unique within their associated repository. | | `links` | object | No | — | The links value | | `merge_commit` | object | No | — | Merge Commit | | `mergeable` | boolean | No | — | A boolean flag indicating whether the pull request passes all merge checks | | `participants` | any\[] | No | — | The list of users that are collaborating on this pull request. Collaborators are user that: \* are added to the pull request as a reviewer (part of the reviewers list) \* are not explicit reviewers, but have commented on the pull request \* are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id. | | `queued` | boolean | No | — | A boolean flag indicating whether the pull request is queued | | `reason` | string | No | — | Explains why a pull request was declined. This field is only applicable to pull requests in rejected state. | | `rendered` | object | No | — | User provided pull request text, interpreted in a markup language and rendered in HTML | | `reviewers` | any\[] | No | — | The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL. | | `source` | object | No | — | The source value | | `state` | string | No | — | The pull request's current status. | | `summary` | object | No | — | The summary value | | `task_count` | integer | No | — | The number of open tasks for a specific pull request. | | `title` | string | No | — | Title of the pull request. | | `type` | string | No | — | The type value | | `updated_on` | string | No | — | The ISO8601 timestamp the request was last updated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "author": { "description": "The author value" }, "close_source_branch": { "type": "boolean", "description": "A boolean flag indicating if merging the pull request closes the source branch." }, "closed_by": { "description": "Closed By" }, "comment_count": { "type": "integer", "description": "The number of comments for a specific pull request." }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the request was created." }, "destination": { "type": "object", "description": "The destination value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "draft": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is a draft." }, "id": { "type": "integer", "description": "The pull request's unique ID. Note that pull request IDs are only unique within their associated repository." }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "commits": { "type": "object", "description": "A link to a resource related to this object." }, "approve": { "type": "object", "description": "A link to a resource related to this object." }, "diff": { "type": "object", "description": "A link to a resource related to this object." }, "diffstat": { "type": "object", "description": "A link to a resource related to this object." }, "comments": { "type": "object", "description": "A link to a resource related to this object." }, "activity": { "type": "object", "description": "A link to a resource related to this object." }, "merge": { "type": "object", "description": "A link to a resource related to this object." }, "decline": { "type": "object", "description": "A link to a resource related to this object." } } }, "merge_commit": { "type": "object", "description": "Merge Commit", "properties": { "hash": { "type": "string", "description": "The hash value" } } }, "mergeable": { "type": "boolean", "description": "A boolean flag indicating whether the pull request passes all merge checks" }, "participants": { "type": "array", "description": "The list of users that are collaborating on this pull request. Collaborators are user that: * are added to the pull request as a reviewer (part of the reviewers list) * are not explicit reviewers, but have commented on the pull request * are not explicit reviewers, but have approved the pull request Each user is wrapped in an object that indicates the user's role and whether they have approved the pull request. For performance reasons, the API only returns this list when an API requests a pull request by id." }, "queued": { "type": "boolean", "description": "A boolean flag indicating whether the pull request is queued" }, "reason": { "type": "string", "description": "Explains why a pull request was declined. This field is only applicable to pull requests in rejected state." }, "rendered": { "type": "object", "description": "User provided pull request text, interpreted in a markup language and rendered in HTML", "properties": { "title": { "type": "object", "description": "The title value" }, "description": { "type": "object", "description": "The description value" }, "reason": { "type": "object", "description": "The reason value" } } }, "reviewers": { "type": "array", "description": "The list of users that were added as reviewers on this pull request when it was created. For performance reasons, the API only includes this list on a pull request's `self` URL." }, "source": { "type": "object", "description": "The source value", "properties": { "repository": { "description": "The repository value" }, "branch": { "type": "object", "description": "The branch value" }, "commit": { "type": "object", "description": "The commit value" } } }, "state": { "type": "string", "description": "The pull request's current status.", "enum": [ "OPEN", "DRAFT", "QUEUED", "MERGED", "DECLINED", "SUPERSEDED" ] }, "summary": { "type": "object", "description": "The summary value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "task_count": { "type": "integer", "description": "The number of open tasks for a specific pull request." }, "title": { "type": "string", "description": "Title of the pull request." }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "The ISO8601 timestamp the request was last updated." } }, "required": [ "PCID", "pull_request_id", "repo_slug", "workspace" ] } ``` *** ## bitbucket\_pullrequests\_update\_pull\_request\_comment Update a comment on a pull request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `comment_id` | integer | Yes | — | The id of the comment. | | `pull_request_id` | integer | Yes | — | The id of the pull request. | | `repo_slug` | string | Yes | — | This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`. | | `workspace` | string | Yes | — | This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`. | | `content` | object | No | — | The content value | | `created_on` | string | No | — | Created On | | `deleted` | boolean | No | — | The deleted value | | `id` | integer | No | — | The id value | | `inline` | object | No | — | The inline value | | `links` | object | No | — | The links value | | `parent` | object | No | — | Circular schema reference: #/components/schemas/comment | | `pending` | boolean | No | — | The pending value | | `pullrequest` | object | No | — | The pullrequest value | | `resolution` | object | No | — | The resolution object for a Comment. | | `type` | string | Yes | — | The type value | | `updated_on` | string | No | — | Updated On | | `user` | object | No | — | The user value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "comment_id": { "type": "integer", "description": "The id of the comment." }, "pull_request_id": { "type": "integer", "description": "The id of the pull request." }, "repo_slug": { "type": "string", "description": "This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: `{repository UUID}`." }, "workspace": { "type": "string", "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: `{workspace UUID}`." }, "content": { "type": "object", "description": "The content value", "properties": { "raw": { "type": "string", "description": "The text as it was typed by a user." }, "markup": { "type": "string", "description": "The type of markup language the raw content is to be interpreted in.", "enum": [ "markdown", "creole", "plaintext" ] }, "html": { "type": "string", "description": "The user's content rendered as HTML." } } }, "created_on": { "type": "string", "description": "Created On" }, "deleted": { "type": "boolean", "description": "The deleted value" }, "id": { "type": "integer", "description": "The id value" }, "inline": { "type": "object", "description": "The inline value", "properties": { "from": { "type": "integer", "description": "The comment's anchor line in the old version of the file. If the comment is a multi-line comment, this is the ending line number in the old version of the file." }, "to": { "type": "integer", "description": "The comment's anchor line in the new version of the file. If the comment is a multi-line comment, this is the ending line number in the new version of the file." }, "start_from": { "type": "integer", "description": "The starting line number in the old version of the file, if the comment is a multi-line comment. This is null otherwise." }, "start_to": { "type": "integer", "description": "The starting line number in the new version of the file, if the comment is a multi-line comment. This is null otherwise." }, "path": { "type": "string", "description": "The path of the file this comment is anchored to." } }, "required": [ "path" ] }, "links": { "type": "object", "description": "The links value", "properties": { "self": { "type": "object", "description": "A link to a resource related to this object." }, "html": { "type": "object", "description": "A link to a resource related to this object." }, "code": { "type": "object", "description": "A link to a resource related to this object." } } }, "parent": { "type": "object", "description": "Circular schema reference: #/components/schemas/comment" }, "pending": { "type": "boolean", "description": "The pending value" }, "pullrequest": { "description": "The pullrequest value" }, "resolution": { "type": "object", "description": "The resolution object for a Comment.", "properties": { "type": { "type": "string", "description": "The type value" }, "user": { "description": "The user value" }, "created_on": { "type": "string", "description": "The ISO8601 timestamp the resolution was created." } }, "required": [ "type" ] }, "type": { "type": "string", "description": "The type value" }, "updated_on": { "type": "string", "description": "Updated On" }, "user": { "description": "The user value" } }, "required": [ "PCID", "comment_id", "pull_request_id", "repo_slug", "workspace", "type" ] } ```