Get a request's comments

GET

/collections/:collectionId/requests/:requestId/comments

GET

/collections/:collectionId/requests/:requestId/comments

$ curl https://api.postman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2/requests/12345678-c82dd02c-4870-4907-8fcb-593a876cf05b/comments \
>      -H "x-api-key: <apiKey>"

1 {
2   "data": [
3     {
4       "id": 46818,
5       "threadId": 12345,
6       "status": "Open",
7       "createdBy": 12345678,
8       "createdAt": "2024-01-18T12:00:54.000Z",
9       "updatedAt": "2024-01-18T12:00:54.000Z",
10       "body": "This is also an example."
11     },
12     {
13       "id": 46817,
14       "threadId": 67890,
15       "status": "Resolved",
16       "createdBy": 87654321,
17       "createdAt": "2024-01-18T11:48:01.000Z",
18       "updatedAt": "2024-01-18T11:48:01.000Z",
19       "body": "Another example."
20     },
21     {
22       "id": 46814,
23       "threadId": 23456,
24       "status": "Open",
25       "createdBy": 12345678,
26       "createdAt": "2024-01-18T11:30:40.000Z",
27       "updatedAt": "2024-01-18T11:30:40.000Z",
28       "body": "This is an example."
29     }
30   ]
31 }

Gets all comments left by users in a request.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

collectionIdstringRequiredformat: "uid"

The collection's unique ID.

requestIdstringRequiredformat: "uid"

The request's unique ID.

Response

Successful Response

datalist of objects

A list of comments.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error