Get an API's comments | Postman Docs

{
  "data": [
    {
      "id": 46818,
      "threadId": 12345,
      "status": "Open",
      "createdBy": 12345678,
      "createdAt": "2024-01-18T12:00:54.000Z",
      "updatedAt": "2024-01-18T12:00:54.000Z",
      "body": "This is also an example."
    },
    {
      "id": 46817,
      "threadId": 67890,
      "status": "Resolved",
      "createdBy": 87654321,
      "createdAt": "2024-01-18T11:48:01.000Z",
      "updatedAt": "2024-01-18T11:48:01.000Z",
      "body": "Another example."
    },
    {
      "id": 46814,
      "threadId": 23456,
      "status": "Open",
      "createdBy": 12345678,
      "createdAt": "2024-01-18T11:30:40.000Z",
      "updatedAt": "2024-01-18T11:30:40.000Z",
      "body": "This is an example."
    }
  ]
}

Gets all comments left by users in an API.

Authentication

x-api-keystring

API Key authentication via header

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

$	curl https://api.postman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments \
>	-H "x-api-key: <apiKey>"