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 Collections API

The **Collections** endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/).

APIs.io Engineering Platform Collections 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 Collection. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 29 operations across 21 paths, and defines 27 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.

29 operations 21 paths 27 schemas 3 DELETE11 GET2 PATCH9 POST4 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 Collections 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 29

Across 21 paths, the API surfaces 29 operations — 3 DELETE, 11 GET, 2 PATCH, 9 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Collections 29

The Collections endpoints enable you to manage your Postman [Collections](https://learning.postman.com/docs/sending-requests/intro-to-collections/).

POST
/apis/{apiId}/collections
APIs.io Engineering Platform Add a collection
addApiCollection 2 params body → 200400401403404500
GET
/apis/{apiId}/collections/{collectionId}
APIs.io Engineering Platform Get a collection
getApiCollection 4 params → 200400401403404422500
PUT
/apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks
APIs.io Engineering Platform Sync collection with schema
syncCollectionWithSchema 3 params → 202400401403404422500
GET
/collection-access-keys
APIs.io Engineering Platform Get collection access keys
getCollectionAccessKeys 2 params → 200400401403500
DELETE
/collection-access-keys/{keyId}
APIs.io Engineering Platform Delete a collection access key
deleteCollectionAccessKey 1 param → 204401403404500
GET
/collections
APIs.io Engineering Platform Get all collections
getCollections 2 params → 200401500
POST
/collections
APIs.io Engineering Platform Create a collection
createCollection 1 param body → 200400401500
POST
/collections/fork/{collectionId}
APIs.io Engineering Platform Create a fork
createCollectionFork 2 params body → 200401404500
POST
/collections/merge
APIs.io Engineering Platform Merge a fork
mergeCollectionFork body → 200401403404500
GET
/collections/{collectionId}
APIs.io Engineering Platform Get a collection
getCollection 3 params → 200400401500
PUT
/collections/{collectionId}
APIs.io Engineering Platform Replace a collection's data
putCollection 1 param body → 200400401403404500
PATCH
/collections/{collectionId}
APIs.io Engineering Platform Update part of a collection
patchCollection 1 param body → 200400401403404500
DELETE
/collections/{collectionId}
APIs.io Engineering Platform Delete a collection
deleteCollection 1 param → 200401404500
GET
/collections/{collectionId}/collection-forks
APIs.io Engineering Platform Get all forked collections
getCollectionsForkedByUser 4 params → 200400401500
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}/forks
APIs.io Engineering Platform Get a collection's forks
getCollectionForks 4 params → 200400404500
PUT
/collections/{collectionId}/pulls
APIs.io Engineering Platform Pull source changes
pullCollectionChanges 1 param → 200400404500
GET
/collections/{collectionId}/pull-requests
APIs.io Engineering Platform Get a collection's pull requests
getCollectionPullRequests 1 param → 200403500
POST
/collections/{collectionId}/pull-requests
APIs.io Engineering Platform Create a pull request
createCollectionPullRequest 1 param body → 200400403500
GET
/collections/{collectionId}/roles
APIs.io Engineering Platform Get a collection's roles
getCollectionRoles 1 param → 200401403404500
PATCH
/collections/{collectionId}/roles
APIs.io Engineering Platform Update a collection's roles
updateCollectionRoles 1 param body → 204400401403404500
GET
/collections/{collectionId}/source-status
APIs.io Engineering Platform Get source collection's status
getSourceCollectionStatus 1 param → 200400500
GET
/collections/{collectionId}/transformations
APIs.io Engineering Platform Transform collection to OpenAPI
transformCollectionToOpenAPI 2 params → 200401404500
POST
/collection-folders-transfers
APIs.io Engineering Platform Transfer folders
transferCollectionFolders body → 200400500
POST
/collection-requests-transfers
APIs.io Engineering Platform Transfer requests
transferCollectionRequests body → 200400500
POST
/collection-responses-transfers
APIs.io Engineering Platform Transfer responses
transferCollectionResponses body → 200400500

Schemas 27

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

forkCollection400ErrorBadForkRelation
object
4 properties
cakNotFound404Error
object
4 properties
apiVersionId
string
commentResponse
object
1 property
pullRequest400ErrorDuplicate
object
4 properties
limit
integer
workspaceId
string
getCollectionAccessKeys
object
2 properties
comment403Error
object
4 properties
apiSchema403ErrorForbidden
object
3 properties
common403Error
object
4 properties
featureUnavailable403Error
object
4 properties
api404ErrorNotFound
object
3 properties
api403ErrorForbidden
object
3 properties
apiCollection400InvalidParam
object
3 properties
cursor
string
api400ErrorVersionIdMissing
object
3 properties
commentCreatedUpdated
object
1 property
commentCreateUpdate
object
Information about the comment.
2 properties 1 required
apiSchema404ErrorNotFound
object
3 properties
pullRequest403ErrorRolePermissionsCollection
object
4 properties
transferCollectionItems
object
4 properties 4 required
ascDesc
string
pullRequest403ErrorNoViewerAccessCollections
object
4 properties
getCollection
object
1 property
apiCollection404ErrorNotFound
object
1 property
v10HeaderMissing
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-collections-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 Collections 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.