How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Comments API

The **Comments** endpoints enable you to manage comments on an API element. You can use [comments](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/discussing-your-work/) to collaborate and discuss your work with your teammates in Postman.

APIs.io Engineering Platform Comments API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Comments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 21 operations across 11 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.getpostman.com, https://api.eu.postman.com.

21 operations 11 paths 6 schemas 5 DELETE5 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

APIs.io Engineering Platform Comments API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (PostmanApiKey). An API key is passed in the header as Authorization (scimApiKey). By default, every request must be authenticated.

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

Paths & Operations 21

Across 11 paths, the API surfaces 21 operations — 5 DELETE, 5 GET, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Comments 21

The Comments endpoints enable you to manage comments on an API element. You can use [comments](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/di…

GET
/apis/{apiId}/comments
APIs.io Engineering Platform Get an API's comments
getApiComments 1 param → 200400401403404500
POST
/apis/{apiId}/comments
APIs.io Engineering Platform Create an API comment
createApiComment 1 param body → 201400401403404500
PUT
/apis/{apiId}/comments/{commentId}
APIs.io Engineering Platform Update an API's comment
updateApiComment 2 params body → 200400401403404500
DELETE
/apis/{apiId}/comments/{commentId}
APIs.io Engineering Platform Delete an API's comment
deleteApiComment 2 params → 204400401403404500
GET
/collections/{collectionId}/comments
APIs.io Engineering Platform Get a collection's comments
getCollectionComments 1 param → 200401403404500
POST
/collections/{collectionId}/comments
APIs.io Engineering Platform Create a collection comment
createCollectionComment 1 param body → 201401403404500
PUT
/collections/{collectionId}/comments/{commentId}
APIs.io Engineering Platform Update a collection's comment
updateCollectionComment 2 params body → 200401403404500
DELETE
/collections/{collectionId}/comments/{commentId}
APIs.io Engineering Platform Delete a collection's comment
deleteCollectionComment 2 params → 204401403404500
GET
/collections/{collectionId}/folders/{folderId}/comments
APIs.io Engineering Platform Get a folder's comments
getFolderComments 2 params → 200401403404500
POST
/collections/{collectionId}/folders/{folderId}/comments
APIs.io Engineering Platform Create a folder comment
createFolderComment 2 params body → 201401403404500
PUT
/collections/{collectionId}/folders/{folderId}/comments/{commentId}
APIs.io Engineering Platform Update a folder's comment
updateFolderComment 3 params body → 200401403404500
DELETE
/collections/{collectionId}/folders/{folderId}/comments/{commentId}
APIs.io Engineering Platform Delete a folder's comment
deleteFolderComment 3 params → 204401403404500
GET
/collections/{collectionId}/requests/{requestId}/comments
APIs.io Engineering Platform Get a request's comments
getRequestComments 2 params → 200401403404500
POST
/collections/{collectionId}/requests/{requestId}/comments
APIs.io Engineering Platform Create a request comment
createRequestComment 2 params body → 201401403404500
PUT
/collections/{collectionId}/requests/{requestId}/comments/{commentId}
APIs.io Engineering Platform Update a request's comment
updateRequestComment 3 params body → 200401403404500
DELETE
/collections/{collectionId}/requests/{requestId}/comments/{commentId}
APIs.io Engineering Platform Delete a request's comment
deleteRequestComment 3 params → 204401403404500
GET
/collections/{collectionId}/responses/{responseId}/comments
APIs.io Engineering Platform Get a response's comments
getResponseComments 2 params → 200401403404500
POST
/collections/{collectionId}/responses/{responseId}/comments
APIs.io Engineering Platform Create a response comment
createResponseComment 2 params body → 201401403404500
PUT
/collections/{collectionId}/responses/{responseId}/comments/{commentId}
APIs.io Engineering Platform Update a response's comment
updateResponseComment 3 params body → 200401403404500
DELETE
/collections/{collectionId}/responses/{responseId}/comments/{commentId}
APIs.io Engineering Platform Delete a response's comment
deleteResponseComment 3 params → 204401403404500
POST
/comments-resolutions/{threadId}
APIs.io Engineering Platform Resolve a comment thread
resolveCommentThread 1 param → 204401404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are featureUnavailable403Error (4 properties), comment403Error (4 properties), v10HeaderMissing (2 properties), commentCreateUpdate (2 properties). Each schema is shown below with its type and property counts.

commentCreatedUpdated
object
1 property
commentResponse
object
1 property
comment403Error
object
4 properties
featureUnavailable403Error
object
4 properties
commentCreateUpdate
object
Information about the comment.
2 properties 1 required
v10HeaderMissing
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-comments-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Comments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.