> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt. For full content including API reference and SDK examples, see https://learning.postman.com/llms-full.txt. # Get an API's comments GET https://api.getpostman.com/apis/{apiId}/comments Gets all comments left by users in an API. Reference: https://learning.postman.com/api-docs/api-reference/api/get-api-comments ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: Postman API version: 1.0.0 paths: /apis/{apiId}/comments: get: operationId: getApiComments summary: Get an API's comments description: Gets all comments left by users in an API. tags: - api parameters: - name: apiId in: path description: The API's ID. required: true schema: $ref: '#/components/schemas/apiId' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/commentResponse' '400': description: Missing v10 Accept Header content: application/json: schema: $ref: '#/components/schemas/apiErrorNameMessage' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' servers: - url: https://api.getpostman.com description: https://api.getpostman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com components: schemas: apiId: type: string title: apiId CommentDataStatus: type: string enum: - Open - Resolved description: The comment's current status. title: CommentDataStatus commentData: type: object properties: id: type: integer description: The comment's ID. threadId: type: integer description: The comment's thread ID. status: $ref: '#/components/schemas/CommentDataStatus' description: The comment's current status. createdBy: type: integer description: The user ID of the user who created the comment. createdAt: type: string format: date-time description: The date and time at which the comment was created. updatedAt: type: string format: date-time description: The date and time when the comment was last updated. body: type: string description: The contents of the comment. description: Information about the comment. title: commentData commentResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/commentData' description: A list of comments. title: commentResponse apiErrorNameMessage: type: object properties: name: type: string description: The error name. message: type: string description: The error message. title: apiErrorNameMessage CommonErrorTypeTitleDetailStatusType: oneOf: - type: string format: uri-reference - type: string title: CommonErrorTypeTitleDetailStatusType commonErrorTypeTitleDetailStatus: type: object properties: type: $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType' title: type: string description: A short summary of the problem. detail: type: string description: Information about the error. status: type: integer description: The error's HTTP status code. title: commonErrorTypeTitleDetailStatus securitySchemes: PostmanApiKey: type: apiKey in: header name: x-api-key scimApiKey: type: apiKey in: header name: Authorization description: >- 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. basicAuth: type: http scheme: basic ``` ## Examples **Response** ```json { "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." } ] } ``` **SDK Code** ```python Get Comments import requests url = "https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Get Comments const url = 'https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Get Comments package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Get Comments require 'uri' require 'net/http' url = URI("https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Get Comments import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments") .header("x-api-key", "") .asString(); ``` ```php Get Comments request('GET', 'https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Get Comments using RestSharp; var client = new RestClient("https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Get Comments import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/comments")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```