Get a pull request

GET

/pull-requests/:pullRequestId

GET

/pull-requests/:pullRequestId

$ curl https://api.postman.com/pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8 \
>      -H "x-api-key: <apiKey>"

1 {
2   "createdAt": "2024-02-20T09:55:46.000Z",
3   "updatedAt": "2024-02-20T09:58:38.000Z",
4   "id": "4e1a6609-1a29-4037-a411-89ecc14c6cd8",
5   "title": "Test PR",
6   "description": "This is a test pull request.",
7   "createdBy": "12345678",
8   "updatedBy": "12345678",
9   "comment": "Missing descriptions in requests",
10   "source": {
11     "id": "87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef",
12     "name": "test-collection",
13     "forkName": "Taylor Lee's fork",
14     "exists": true
15   },
16   "destination": {
17     "id": "123456789-24f57217-1169-4b7c-a810-0e957c04eaa5",
18     "name": "test-collection",
19     "exists": true
20   },
21   "status": "declined",
22   "merge": {
23     "status": "inactive"
24   },
25   "reviewers": [
26     {
27       "id": "12345678",
28       "status": "declined"
29     }
30   ],
31   "forkType": "collection"
32 }

Gets information about a pull request, such as the source and destination details, who reviewed the pull request, the merge's current status, and whether the element is accessible.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

pullRequestIdstringRequired

The pull request's ID.

Response

Successful Response

createdAtstringOptional

The date and time at which the pull request was created.

updatedAtstringOptional

The date and time at which the pull request was updated.

idstringOptional

The pull request's ID.

titlestringOptional

The pull request's title.

descriptionstringOptional

The pull request's description.

createdBystringOptional

The ID of the user who created the pull request.

updatedBystringOptional

The ID of the user who last updated the pull request.

commentstringOptional

If the pull request is a decline status, an optional comment about why the pull request was declined.

fortkTypestringOptional

The type of element the pull request was forked from.

sourceobjectOptional

Information about the pull request’s source (parent) element.

destinationobjectOptional

Information about the pull request destination element.

statusstringOptional

The pull request’s current review status:

open — The pull request is still open.
approved — The pull request was approved by its reviewers.
declined — The pull request was not approved by its reviewers.

mergeobjectOptional

Information about the current progress of the pull request's merge.

reviewerslist of objectsOptional

Information about the reviewers assigned to the pull request.

Errors

403

Forbidden Error

500

Internal Server Error