Get an API's comments

Deprecated

GET

/apis/:apiId/comments

GET

/apis/:apiId/comments

$ curl https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/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 an API.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

apiIdstringRequired

The API's ID.

Response

Successful Response

datalist of objects

A list of comments.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error