Postman Collections API
The Collections API lets you programmatically create, read, update, and delete Postman Collections including requests, folders, scripts, and environments. Powers CI/CD integration, sync, and collection generation pipelines.
Postman Collections API is one of 39 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include API Management, Automation, Collection, and CRUD. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 31 operations across 22 paths, and defines 270 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.
31 operations
22 paths
270 schemas
3 DELETE12 GET2 PATCH9 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Postman Collections API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (PostmanApiKey).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as Authorization (scimApiKey).
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 31
Across 22 paths, the API surfaces 31 operations — 3 DELETE, 12 GET, 2 PATCH, 9 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
collections 31
PUT
/collection-merges
Merge or pull changes into a collection fork
GET
/collection-merges-tasks/{taskId}
Get merge or pull task status
GET
/collections
Get all collections
POST
/collections
Create a collection
GET
/collections/collection-forks
Get all forked collections
POST
/collections/fork/{collectionId}
Create a fork
POST
/collections/merge
Merge a fork
GET
/collections/{collectionId}
Get a collection
PUT
/collections/{collectionId}
Replace a collection's data
DELETE
/collections/{collectionId}
Delete a collection
PATCH
/collections/{collectionId}
Update part of a collection
GET
/collections/{collectionId}/comments
Get a collection's comments
POST
/collections/{collectionId}/comments
Create a collection comment
PUT
/collections/{collectionId}/comments/{commentId}
Update a collection's comment
DELETE
/collections/{collectionId}/comments/{commentId}
Delete a collection's comment
POST
/collections/{collectionId}/duplicates
Duplicate a collection
GET
/collections/{collectionId}/forks
Get a collection's forks
PUT
/collections/{collectionId}/public-documentations
Publish documentation
DELETE
/collections/{collectionId}/public-documentations
Unpublish documentation
PUT
/collections/{collectionId}/pulls
Pull source changes
GET
/collections/{collectionId}/pull-requests
Get a collection's pull requests
POST
/collections/{collectionId}/pull-requests
Create a pull request
GET
/collections/{collectionId}/roles
Get a collection's roles
PATCH
/collections/{collectionId}/roles
Update a collection's roles
GET
/collections/{collectionId}/source-status
Get source collection's status
GET
/collections/{collectionId}/transformations
Transform collection to OpenAPI
POST
/collection-folders-transfers
Transfer folders
POST
/collection-requests-transfers
Transfer requests
POST
/collection-responses-transfers
Transfer responses
GET
/collection-duplicate-tasks/{taskId}
Get duplication task status
GET
/collection-updates-tasks/{taskId}
Get async collection update status
Schemas 270
The contract defines 270 schemas that model the data the API accepts and returns. The most detailed are protocol-profile-behavior (14 properties), auth-2 (13 properties), GetCollectionPullRequestsDataItems (12 properties), auth (12 properties). Each schema is shown below with its type and property counts.
GetCollectionsCollectionsItems
object
Information about the collection.
8 properties
AsyncMergeCollectionForkTask
object
Information about the merge task.
2 properties
event-list
array
A list of scripts configured to run when specific events occur.
CollectionVariableListItems
GetCollectionCollection
object
For a complete list of this endpoint's possible values, use the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/dra…
5 properties
createCollectionFork
object
1 property
1 required
GetCollectionsRequestUnauthorizedError
commonErrorNameMessageDetails
object
1 property
documentationColorSettings
object
The theme's colors, in six digit hexcode. The values in this object must match the hexcode values of either the light or dark theme defined in the appearance o…
3 properties
CommonErrorTypeTitleDetailStatusType
documentationMetaTags
object
2 properties
2 required
AsyncMergePullCollectionForkRequestUnauthorizedError
GetCollectionRolesRequestUnauthorizedError
commonErrorTypeTitleDetail
object
3 properties
UpdateCollectionRolesRequestUnauthorizedError
commonErrorTypeTitle
object
2 properties
CreateCollectionRequestInternalServerError
createCollectionSchema
object
6 properties
2 required
environmentVariableSource
object
Information about the source of the variable's value.
2 properties
url
Information about the URL.
GetCollectionCollectionInfo
object
Information about the collection.
9 properties
collection-variable
object
Information about a collection-level variable. Collection variables don't support id, description, or enabled fields. Use disabled to control whether a variabl…
3 properties
CreateCollectionRequestUnauthorizedError
putCollection
object
1 property
GetCollectionsForkedByUserRequestUnauthorizedError
limit
integer
publishDocumentationResponse
object
10 properties
commentTaggedUsers
object
Information about users tagged in the body comment.
1 property
TransferCollectionItemsMode
string
The transfer operation to perform.
AsyncMergePullCollectionTaskStatusDetails
object
If the task failed, an object containing information about the error.
1 property
commentData
object
Information about the comment.
7 properties
UpdateCollectionRolesRequestInternalServerError
RequestBody
object
Information about the collection's request body. To set this to "none", pass an empty object.
7 properties
GetCollectionPullRequestsRequestInternalServerError
PutCollectionRequestUnauthorizedError
VariableList2Items
pullRequestCreated
object
9 properties
DuplicateCollectionRequestInternalServerError
ResponseHeader
GetCollectionRolesRequestInternalServerError
DeleteCollectionRequestInternalServerError
UpdateCollectionRolesRolesItemsPath
string
The resource to perform the action on.
collection-variable-list
array
A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/). Make certain not to include sensitive informat…
documentationThemeSettings
object
3 properties
patchCollection
object
1 property
RequestBodyFormdataItemsOneOf0Type
string
The text value.
putCollectionResponse
object
1 property
CollectionCreatedCollection
object
3 properties
collectionTransformFormat
string
CreateCollectionPullRequestRequestInternalServerError
EnvironmentVariableSourcePostman
object
Information about the Postman-specific source of the variable's value.
3 properties
PutCollectionRequestNotFoundError
GetCollectionForksDataItems
object
Information about the forked collection.
4 properties
EnvironmentVariableSourceProvider
string
The secret's provider.
GetCollectionRolesUserItems
object
Information about the user role.
2 properties
Variable2Value
The key's value.
EnvironmentVariableSourcePostmanType
string
The variable's type: - cloud — The variable value is synced and stored in the Postman Cloud.
CommentTaggedUsersUserName
object
An object that contains information about the tagged user. The object's name is the user's Postman username. For example, @user-postman.
2 properties
2 required
AsyncCollectionForkMergeStrategy
string
The fork's merge strategy: - default — Make no changes to the fork. You must have Editor access to the destination collection. - updateSourceWithDestination —…
header-list
array
A list of headers.
createCollection
object
1 property
AsyncMergePullCollectionForkRequestInternalServerError
GetCollectionForksMeta
object
The response's meta information for paginated results.
2 properties
InfoSchema
string
The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema.
protocol-profile-behavior
object
The [settings](https://learning.postman.com/docs/sending-requests/create-requests/request-settings/) used to alter the [Protocol Profile Behavior](https://gith…
14 properties
GetSourceCollectionStatusCollection
object
1 property
CommonErrorNameMessageError
object
Information about the error.
2 properties
PutCollectionResponseCollection
object
3 properties
Request2BodyUrlencodedItems
object
3 properties
1 required
AsyncMergePullCollectionTaskStatusDetailsError
object
1 property
publishDocumentation
object
4 properties
2 required
Request2BodyFormdataItemsOneOf1Type
string
The file value.
CreateCollectionForkResponseCollectionFork
object
Information about the collection's fork.
3 properties
TransferCollectionItemsLocationPosition
string
The transferred item's position within the destination object.
environmentSecret
boolean
If true, the variable is marked as secret and its value is retrieved from the mentioned provider in the source field.
variable-list-2
array
A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/). Make certain not to include sensitive informat…
Fork400ErrorNoUserFoundError
object
2 properties
PutCollectionRequestBadRequestError
collectionUid
string
getCollectionsForkedByUser
object
2 properties
DuplicateCollectionResponseTask
object
3 properties
RequestBodyUrlencodedItems
object
3 properties
1 required
PatchCollectionResponseCollection
object
3 properties
collectionNameQuery
string
DuplicateCollectionResponseTaskStatus
string
The status of the collection duplication task.
MergeCollectionForkResponseCollection
object
2 properties
CreateCollectionForkRequestUnauthorizedError
createCollectionForkResponse
object
1 property
GetSourceCollectionStatusRequestInternalServerError
getCollectionForks
object
2 properties
modifyCollectionSchema
object
6 properties
2 required
pullCollectionChangesResponse
object
1 property
collectionForkTaskId
string
TransferCollectionItemsLocation
object
The transferred items' placement in the target destination: - For start or end — Do not include the model and id values. - For before or after — Include the mo…
3 properties
1 required
MergeCollectionForkStrategy
string
The fork's merge strategy: - deleteSource — Merge the changes into the parent collection. After the merge process is complete, Postman deletes the fork. You mu…
GetCollectionRolesGroupItems
object
Information about the group role.
2 properties
Request2BodyGraphql
object
If the mode value is graphql, an object containing the GraphQL request information.
2 properties
Request2BodyMode
string
The data associated with the request.
RequestBodyFormdataItems0
object
5 properties
TransferCollectionRequestsRequestInternalServerError
commonErrorTypeTitleDetailStatusInstance
object
5 properties
getCollectionPullRequests
object
1 property
Auth2Type
string
The authorization type.
documentationCustomizationSettings
object
Information about the documentation's customization.
2 properties
commonErrorNameMessage
object
1 property
info
object
Information about the collection.
3 properties
2 required
CommentTaggedUsersUserNameType
string
The user value.
commentUpdate
object
Information about the comment.
2 properties
1 required
EventListen
string
Can be set to test or prerequest for test scripts or pre-request scripts respectively.
ProtocolProfileBehaviorProtocolVersion
string
The HTTP protocol version to use. Supports the http1, http2, and auto values.
AuthType
string
The authorization type.
Request2BodyFormdataItemsOneOf1Src
RequestBodyFormdataItems1
object
5 properties
taskId
string
mergeCollectionFork
object
3 properties
2 required
TransferCollectionItemsTarget
object
Information about the item transfer's destination location.
2 properties
2 required
metaLimitOffsetTotal
object
The response's meta information for paginated results.
3 properties
collectionId
string
header
object
Information about the header.
4 properties
2 required
UpdateCollectionRolesRolesItemsValueItems
object
Information about the updated role.
2 properties
2 required
fork400ErrorNoUserFound
object
1 property
GetCollectionCollectionInfoFork
object
If the collection was forked from another collection, this object contains information about the fork.
3 properties
asyncMergePullCollectionTaskStatus
object
3 properties
event-2
object
Information about the collection's events.
3 properties
1 required
GetCollectionRolesUserItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
commentId
integer
Request2BodyFormdataItems
Prefer
string
PutCollectionRequestForbiddenError
header-2
object
Information about the header.
3 properties
2 required
script-2
object
Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
3 properties
RequestBodyFormdataItemsOneOf1Src
UpdateCollectionRolesRolesItemsOp
string
The operation to perform on the path.
auth-2
object
The [authorization type supported by Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
13 properties
1 required
transferCollectionItemsResponse
object
1 property
ascDesc
string
request
object
Information about the collection request.
6 properties
GetCollectionRolesTeamItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
GetDuplicateCollectionTaskStatusRequestForbiddenError
GetDuplicateCollectionTaskStatusRequestInternalServerError
CommonErrorNameMessageDetailsErrorDetails
Information about the error.
workspaceId
string
getCollection
object
1 property
documentationApperanceSettings
object
Information about the documentation appearance, such as colors and theme.
2 properties
item
object
Information about the collection request or folder.
7 properties
transferCollectionItems
object
4 properties
4 required
PatchCollectionCollection
The collection updates to apply. You must pass at least one of the following: info, variable, auth, or events. Unsupported properties are rejected.
DuplicateCollectionRequestUnauthorizedError
getCollectionUpdatesTasks
object
2 properties
AuthAttributeValueOneOf1Items
object
DeleteCollectionCollection
object
Information about the deleted collection.
2 properties
commentResponse
object
1 property
GetCollectionPullRequestsDataItemsStatus
string
The pull request's current status.
variable-2
object
Information about the variable.
6 properties
GetCollectionsForkedByUserMeta
object
The response's meta information for paginated results.
3 properties
cursor
string
GetCollectionUpdatesTasksRequestForbiddenError
Info2Schema
string
The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema.
Event2Listen
string
The prerequest (pre-request) or test (post-response) value.
Request2BodyOptions
object
Additional configurations and options set for various modes.
DuplicateCollectionRequestBadRequestError
PullCollectionChangesResponseCollection
object
Information about the updated collection fork.
2 properties
RequestBodyMode
string
The data associated with the request.
updateCollectionRoles
object
1 property
1 required
patchCollectionResponse
object
1 property
Request2BodyFile
object
If the mode value is file, an object containing the file request information.
1 property
VariableValue
The key's value.
fork404Error
object
1 property
Response2Header1
array
A list of the request's headers.
Request2BodyFormdataItems0
object
5 properties
duplicateCollection
object
2 properties
1 required
AsyncMergePullCollectionTaskStatusRequestInternalServerError
Url1
object
6 properties
event-list-2
array
A list of scripts configured to run when specific events occur. These scripts can be referenced in the collection by their ID.
event
object
Information about the collection's events.
2 properties
1 required
auth
object
The [authorization type supported by Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
12 properties
1 required
secretVariable
object
Information about the secret variable.
6 properties
TransferCollectionResponsesRequestInternalServerError
pullRequestCreate
object
Information about the pull request.
4 properties
3 required
PatchCollectionRequestUnauthorizedError
mergeCollectionForkResponse
object
1 property
item-2
object
Information about the collection request or folder.
11 properties
1 required
commentCreatedUpdated
object
1 property
AuthAttributeValue1
array
CommentDataStatus
string
The comment's current status.
transformCollectionToOpenAPI
object
1 property
collectionAccessKeyQuery
string
info-2
object
Information about the collection.
8 properties
2 required
DocumentationThemeSettingsName
string
The light or dark theme.
CommentCreatedUpdatedData
object
6 properties
Response2Header
MergeCollectionForkRequestUnauthorizedError
DeleteCollectionRequestUnauthorizedError
MergeCollectionForkRequestInternalServerError
request-2
object
Information about the collection request.
6 properties
GetCollectionUpdatesTasksStatus
string
The task's current status.
GetCollectionsForkedByUserRequestInternalServerError
variable-list
array
A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/). Make certain not to include sensitive informat…
GetCollectionsRequestInternalServerError
Request2BodyFormdataItemsOneOf0Type
string
The text value.
asyncCollectionForkMerge
object
3 properties
3 required
TransferCollectionItemsTargetModel
string
The collection, folder, or request that the items will be transferred to. For response transfers, use the request value.
Request2BodyFormdataItems1
object
5 properties
PublishDocumentationDocumentationLayout
string
The documentation's default layout style: - classic-single-column — Displays sample code inline beneath each request. - classic-double-column — Displays sample…
DocumentationApperanceSettingsDefault
string
The default color theme (light or dark). Documentation uses the given theme value by default.
commentCreate
object
Information about the comment.
3 properties
1 required
offsetNoDefault
integer
forkCollection400Error
object
1 property
AsyncMergePullCollectionTaskStatusRequestUnauthorizedError
auth-attribute
object
Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
3 properties
1 required
variable
object
Information about the variable.
4 properties
response
object
Information about the request's response.
6 properties
GetCollectionRolesGroupItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
asyncMergeCollectionFork
object
1 property
GetSourceCollectionStatusCollectionCollectionUid
object
Information about the forked collection. The object's name is the forked collection's UID (userId-collectionId).
1 property
GetCollectionUpdatesTasksRequestUnauthorizedError
PutCollectionRequestInternalServerError
GetCollectionPullRequestsDataItems
object
Information about the pull request.
12 properties
GetCollectionForksRequestInternalServerError
AuthAttributeValue
The key's value.
MergeCollectionForkRequestForbiddenError
CreateCollectionForkResponseCollection
object
Information about the forked collection.
4 properties
RequestBodyFile
object
If the mode value is file, an object containing the file request information.
1 property
CreateCollectionForkRequestInternalServerError
GetCollectionRequestUnauthorizedError
response-2
object
Information about the request's response.
10 properties
PullCollectionChangesRequestInternalServerError
PatchCollectionRequestBadRequestError
collectionCreated
object
1 property
GetCollectionsCollectionsItemsFork
object
If the collection is [forked](https://learning.postman.com/docs/collaborating-in-postman/version-control/forking-postman-entities), the fork's information.
3 properties
GetCollectionRolesRequestForbiddenError
deleteCollection
object
1 property
collection-secret-variable
object
Information about a collection-level secret variable. Collection variables don't have an id field.
5 properties
limitNoDefault
integer
PatchCollectionRequestForbiddenError
getCollectionRoles
object
Information about the collection's roles.
3 properties
GetDuplicateCollectionTaskStatusRequestUnauthorizedError
getSourceCollectionStatus
object
1 property
commonErrorTypeTitleDetailStatus
object
4 properties
GetCollectionRolesTeamItems
object
Information about the team role.
2 properties
ProtocolProfileBehaviorDisabledSystemHeaders
object
Disable the system headers which are added implicitly.
7 properties
UrlOneOf1QueryItems
object
4 properties
AsyncMergePullCollectionTaskStatusStatus
string
The task's current status.
GetCollectionUpdatesTasksRequestInternalServerError
UpdateCollectionRolesRolesItemsValueItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
CollectionVariableValue
The key's value.
GetCollectionsForkedByUserDataItems
object
Information about the forked collection.
4 properties
AuthAttributeType
string
The value's type.
RequestBodyFormdataItemsOneOf1Type
string
The file value.
UpdateCollectionRolesRequestForbiddenError
ForkCollection400ErrorCollection
object
2 properties
UpdateCollectionRolesRolesItems
object
3 properties
3 required
duplicateCollectionResponse
object
1 property
header-list-2
array
A list of headers.
RequestBodyGraphql
object
If the mode value is graphql, an object containing the GraphQL request information.
2 properties
GetCollectionRequestInternalServerError
Request2Body
object
Information about the collection's request body.
7 properties
script
object
Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
2 properties
collectionModelQuery
string
PatchCollectionRequestInternalServerError
RequestBodyFormdataItems
taskUid
string
getCollections
object
2 properties
CommonErrorTypeTitleDetailDetail
Information about the error.
ResponseHeader1
array
A list of the request's headers.
CommonErrorNameMessageDetailsError
object
3 properties
Fork404ErrorError
object
2 properties
DuplicateCollectionRequestForbiddenError
TransferCollectionFoldersRequestInternalServerError
RequestBodyOptions
object
Additional configurations and options set for various modes.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Postman 12
Other APIs Postman publishes across the network.
Postman
Postman Workspaces API
Postman Environments API
Postman Monitors API
Postman Webhooks API
Postman Tags API
Postman Billing API
Postman SCIM API
Postman MCP Server
Postman Flows
Postman Mocks API
Postman analytics API
#API Management#Automation#Collection#CRUD
Where this information came from
This is an independent, third-party profile of Postman 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.