Get a collection's pull requests

GET

/collections/:collectionId/pull-requests

GET

/collections/:collectionId/pull-requests

$ curl https://api.postman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2/pull-requests \
>      -H "x-api-key: <apiKey>"

1 {
2   "data": [
3     {
4       "createdAt": "2024-02-20T09:55:46.000Z",
5       "createdBy": "12345678",
6       "description": "This is an open pull request.",
7       "destinationId": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
8       "href": "/pull-requests/4e1a6609-1a29-4037-a411-89ecc14c6cd8",
9       "id": "4e1a6609-1a29-4037-a411-89ecc14c6cd8",
10       "sourceId": "87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef",
11       "status": "open",
12       "title": "Open PR",
13       "updatedBy": "12345678",
14       "updatedAt": "2024-02-20T09:58:38.000Z"
15     },
16     {
17       "createdAt": "2024-02-20T09:58:57.000Z",
18       "createdBy": "12345678",
19       "description": "This is an approved PR.",
20       "destinationId": "12345678-24f57217-1169-4b7c-a810-0e957c04eaa5",
21       "href": "/pull-requests/ac959187-568f-4e5e-9d17-584eb44fbed2",
22       "id": "ac959187-568f-4e5e-9d17-584eb44fbed2",
23       "sourceId": "87654321-e50a18a3-0dcd-49cb-afa5-d3a82cdf6134",
24       "status": "approved",
25       "title": "Approved PR",
26       "updatedBy": "12345678",
27       "updatedAt": "2024-02-20T09:58:57.000Z"
28     },
29     {
30       "createdAt": "2024-02-20T09:55:46.000Z",
31       "createdBy": "12345678",
32       "description": "This is a declined PR.",
33       "destinationId": "12345678-c7f30bd9-5cc7-4569-a5fe-92270af33c6c",
34       "href": "/pull-requests/eda21e1f-8688-43aa-8660-35337dbac04b",
35       "id": "eda21e1f-8688-43aa-8660-35337dbac04b",
36       "sourceId": "87654321-4beee503-1a7a-4925-a165-16fc29eaad22",
37       "status": "declined",
38       "comment": "Missing information.",
39       "title": "Declined PR",
40       "updatedBy": "12345678",
41       "updatedAt": "2024-02-20T09:58:38.000Z"
42     }
43   ]
44 }

Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull requests, and a URL link to the pull requests.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

collectionIdstringRequiredformat: "uid"

The collection's unique ID.

Response

Successful Response

datalist of objects

Errors

403

Forbidden Error

500

Internal Server Error