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 43 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include API Management, Automation, Collection, and CRUD. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.
This API exposes 34 operations across 25 paths, and defines 281 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 3 base URLs: https://api.postman.com, https://api.eu.postman.com, https://api.getpostman.com.
34 operations
25 paths
281 schemas
3 DELETE15 GET2 PATCH9 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Postman Collections API declares
4 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).
An API key is passed in the header as x-api-key (apiKeyAuth).
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…apiKeyAuth— Postman API key for authentication.
Paths & Operations 34
Across 25 paths, the API surfaces 34 operations — 3 DELETE, 15 GET, 2 PATCH, 9 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Collections 34
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
GET
/collections/{collectionId}/requests
Postman Get all requests in a collection
GET
/collections/{collectionId}/folders
Postman Get all folders in a collection
GET
/collections/{collectionId}/responses
Postman Get all responses in a collection
Schemas 281
The contract defines 281 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.
commonErrorTypeTitleDetail
object
3 properties
collectionForkTaskId
string
collectionTransformFormat
string
PullCollectionChangesRequestInternalServerError
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
DuplicateCollectionRequestBadRequestError
DeleteCollectionCollection
object
Information about the deleted collection.
2 properties
CreateCollectionForkResponseCollection
object
Information about the forked collection.
4 properties
EventListen
string
Can be set to test or prerequest for test scripts or pre-request scripts respectively.
AuthAttributeType
string
The value's type.
environmentSecret
boolean
If true, the variable is marked as secret and its value is retrieved from the mentioned provider in the source field.
GetCollectionRolesRequestUnauthorizedError
transformCollectionToOpenAPI
object
1 property
DuplicateCollectionResponseTaskStatus
string
The status of the collection duplication task.
PutCollectionRequestBadRequestError
DocumentationThemeSettingsName
string
The light or dark theme.
commentId
integer
GetCollectionForksMeta
object
The response's meta information for paginated results.
2 properties
PatchCollectionRequestInternalServerError
putCollectionResponse
object
1 property
PatchCollectionRequestUnauthorizedError
pullRequestCreated
object
9 properties
GetCollectionsForkedByUserDataItems
object
Information about the forked collection.
4 properties
AuthAttributeValueOneOf1Items
object
PutCollectionRequestInternalServerError
DeleteCollectionRequestUnauthorizedError
DuplicateCollectionRequestInternalServerError
CommonErrorNameMessageDetailsErrorDetails
Information about the error.
commentData
object
Information about the comment.
7 properties
request-2
object
Information about the collection request.
6 properties
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…
fork404Error
object
1 property
collectionUid
string
TransferCollectionItemsMode
string
The transfer operation to perform.
variable-2
object
Information about the variable.
6 properties
UpdateCollectionRolesRequestInternalServerError
PutCollectionRequestUnauthorizedError
GetCollectionCollectionInfo
object
Information about the collection.
9 properties
CommentDataStatus
string
The comment's current status.
item
object
Information about the collection request or folder.
7 properties
RequestBodyFormdataItems
GetCollectionRequestUnauthorizedError
EnvironmentVariableSourceProvider
string
The secret's provider.
getCollectionPullRequests
object
1 property
CommentTaggedUsersUserNameType
string
The user value.
collectionAccessKeyQuery
string
AsyncMergeCollectionForkTask
object
Information about the merge task.
2 properties
GetCollectionsRequestInternalServerError
GetCollectionsRequestUnauthorizedError
collectionId
string
CollectionCreatedCollection
object
3 properties
UpdateCollectionRolesRolesItemsOp
string
The operation to perform on the path.
MergeCollectionForkRequestForbiddenError
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
CreateCollectionForkResponseCollectionFork
object
Information about the collection's fork.
3 properties
script
object
Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
2 properties
header-list
array
A list of headers.
transferCollectionItemsResponse
object
1 property
request
object
Information about the collection request.
6 properties
RequestBodyMode
string
The data associated with the request.
asyncMergeCollectionFork
object
1 property
collectionModelQuery
string
deleteCollection
object
1 property
putCollection
object
1 property
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
commonErrorNameMessageDetails
object
1 property
modifyCollectionSchema
object
6 properties
2 required
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
documentationThemeSettings
object
3 properties
getCollectionUpdatesTasks
object
2 properties
getCollection
object
1 property
DuplicateCollectionRequestForbiddenError
TransferCollectionResponsesRequestInternalServerError
auth
object
The [authorization type supported by Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
12 properties
1 required
RequestBodyFormdataItems1
object
5 properties
documentationCustomizationSettings
object
Information about the documentation's customization.
2 properties
limitNoDefault
integer
ResponseHeader
CommentCreatedUpdatedData
object
6 properties
DuplicateCollectionResponseTask
object
3 properties
UpdateCollectionRolesRolesItemsValueItems
object
Information about the updated role.
2 properties
2 required
mergeCollectionFork
object
3 properties
2 required
publishDocumentation
object
4 properties
2 required
Prefer
string
cursor
string
DeleteCollectionRequestInternalServerError
Request2BodyFormdataItemsOneOf0Type
string
The text value.
collectionCreated
object
1 property
event-2
object
Information about the collection's events.
3 properties
1 required
CommonErrorTypeTitleDetailStatusType
GetCollectionPullRequestsDataItemsStatus
string
The pull request's current status.
Info2Schema
string
The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema.
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…
PatchCollectionRequestForbiddenError
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.
header-2
object
Information about the header.
3 properties
2 required
forkCollection400Error
object
1 property
Response2Header
duplicateCollection
object
2 properties
1 required
Request2BodyUrlencodedItems
object
3 properties
1 required
RequestBodyFormdataItemsOneOf1Src
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
CreateCollectionForkRequestUnauthorizedError
Request2BodyOptions
object
Additional configurations and options set for various modes.
Variable2Value
The key's value.
updateCollectionRoles
object
1 property
1 required
publishDocumentationResponse
object
10 properties
GetDuplicateCollectionTaskStatusRequestInternalServerError
EnvironmentVariableSourcePostmanType
string
The variable's type: - cloud — The variable value is synced and stored in the Postman Cloud.
taskUid
string
UpdateCollectionRolesRequestForbiddenError
header-list-2
array
A list of headers.
RequestBodyFile
object
If the mode value is file, an object containing the file request information.
1 property
ProtocolProfileBehaviorProtocolVersion
string
The HTTP protocol version to use. Supports the http1, http2, and auto values.
AuthAttributeValue
The key's value.
Auth2Type
string
The authorization type.
VariableList2Items
CreateCollectionPullRequestRequestInternalServerError
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
ForkCollection400ErrorCollection
object
2 properties
fork400ErrorNoUserFound
object
1 property
GetDuplicateCollectionTaskStatusRequestUnauthorizedError
Request2Body
object
Information about the collection's request body.
7 properties
RequestBodyGraphql
object
If the mode value is graphql, an object containing the GraphQL request information.
2 properties
CommonErrorTypeTitleDetailDetail
Information about the error.
UpdateCollectionRolesRequestUnauthorizedError
RequestBodyFormdataItems0
object
5 properties
AsyncCollectionForkMergeStrategy
string
The fork's merge strategy: - default — Make no changes to the fork. You must have Editor access to the destination collection. - updateSourceWithDestination —…
commonErrorTypeTitle
object
2 properties
CollectionVariableListItems
script-2
object
Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
3 properties
info
object
Information about the collection.
3 properties
2 required
asyncMergePullCollectionTaskStatus
object
3 properties
event-list
array
A list of scripts configured to run when specific events occur.
patchCollectionResponse
object
1 property
GetCollectionRolesGroupItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
CollectionVariableValue
The key's value.
limit
integer
UpdateCollectionRolesRolesItems
object
3 properties
3 required
commentCreatedUpdated
object
1 property
MergeCollectionForkRequestUnauthorizedError
collection-secret-variable
object
Information about a collection-level secret variable. Collection variables don't have an id field.
5 properties
GetCollectionUpdatesTasksRequestForbiddenError
pullCollectionChangesResponse
object
1 property
ProtocolProfileBehaviorDisabledSystemHeaders
object
Disable the system headers which are added implicitly.
7 properties
MergeCollectionForkRequestInternalServerError
CreateCollectionRequestUnauthorizedError
GetCollectionRolesTeamItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
GetCollectionForksDataItems
object
Information about the forked collection.
4 properties
AuthAttributeValue1
array
TransferCollectionFoldersRequestInternalServerError
AsyncMergePullCollectionTaskStatusDetailsError
object
1 property
header
object
Information about the header.
4 properties
2 required
GetCollectionsForkedByUserMeta
object
The response's meta information for paginated results.
3 properties
secretVariable
object
Information about the secret variable.
6 properties
TransferCollectionItemsTarget
object
Information about the item transfer's destination location.
2 properties
2 required
createCollection
object
1 property
pullRequestCreate
object
Information about the pull request.
4 properties
3 required
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…
GetCollectionUpdatesTasksRequestInternalServerError
CreateCollectionForkRequestInternalServerError
TransferCollectionRequestsRequestInternalServerError
taskId
string
RequestBodyOptions
object
Additional configurations and options set for various modes.
GetSourceCollectionStatusCollection
object
1 property
Request2BodyFormdataItemsOneOf1Src
auth-2
object
The [authorization type supported by Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
13 properties
1 required
GetCollectionRolesUserItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
UpdateCollectionRolesRolesItemsValueItemsRole
string
The role type: - VIEWER — Can view, fork, and export collections. - EDITOR — Can edit collections directly.
GetCollectionsCollectionsItems
object
Information about the collection.
8 properties
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
asyncCollectionForkMerge
object
3 properties
3 required
url
Information about the URL.
Request2BodyFormdataItems
Request2BodyMode
string
The data associated with the request.
event
object
Information about the collection's events.
2 properties
1 required
AsyncMergePullCollectionTaskStatusRequestInternalServerError
duplicateCollectionResponse
object
1 property
ascDesc
string
DuplicateCollectionRequestUnauthorizedError
offsetNoDefault
integer
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
TransferCollectionItemsTargetModel
string
The collection, folder, or request that the items will be transferred to. For response transfers, use the request value.
GetCollectionRolesRequestForbiddenError
GetSourceCollectionStatusCollectionCollectionUid
object
Information about the forked collection. The object's name is the forked collection's UID (userId-collectionId).
1 property
AsyncMergePullCollectionForkRequestInternalServerError
VariableValue
The key's value.
documentationApperanceSettings
object
Information about the documentation appearance, such as colors and theme.
2 properties
GetCollectionRolesRequestInternalServerError
getCollectionRoles
object
Information about the collection's roles.
3 properties
CommonErrorNameMessageDetailsError
object
3 properties
auth-attribute
object
Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
3 properties
1 required
getCollectionsForkedByUser
object
2 properties
commentUpdate
object
Information about the comment.
2 properties
1 required
CommonErrorNameMessageError
object
Information about the error.
2 properties
AsyncMergePullCollectionTaskStatusRequestUnauthorizedError
GetCollectionUpdatesTasksRequestUnauthorizedError
workspaceId
string
GetCollectionPullRequestsRequestInternalServerError
PublishDocumentationDocumentationLayout
string
The documentation's default layout style: - classic-single-column — Displays sample code inline beneath each request. - classic-double-column — Displays sample…
GetCollectionsForkedByUserRequestInternalServerError
GetCollectionRolesTeamItems
object
Information about the team role.
2 properties
getCollections
object
2 properties
commonErrorNameMessage
object
1 property
AuthType
string
The authorization type.
metaLimitOffsetTotal
object
The response's meta information for paginated results.
3 properties
RequestBody
object
Information about the collection's request body. To set this to "none", pass an empty object.
7 properties
AsyncMergePullCollectionTaskStatusDetails
object
If the task failed, an object containing information about the error.
1 property
info-2
object
Information about the collection.
8 properties
2 required
patchCollection
object
1 property
Response2Header1
array
A list of the request's headers.
Request2BodyFormdataItemsOneOf1Type
string
The file value.
InfoSchema
string
The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema.
variable
object
Information about the variable.
4 properties
PutCollectionResponseCollection
object
3 properties
CreateCollectionRequestInternalServerError
GetCollectionUpdatesTasksStatus
string
The task's current status.
RequestBodyUrlencodedItems
object
3 properties
1 required
documentationMetaTags
object
2 properties
2 required
response
object
Information about the request's response.
6 properties
commonErrorTypeTitleDetailStatusInstance
object
5 properties
AsyncMergePullCollectionTaskStatusStatus
string
The task's current status.
Url1
object
6 properties
ResponseHeader1
array
A list of the request's headers.
Request2BodyFile
object
If the mode value is file, an object containing the file request information.
1 property
commentTaggedUsers
object
Information about users tagged in the body comment.
1 property
RequestBodyFormdataItemsOneOf0Type
string
The text value.
Fork404ErrorError
object
2 properties
commonErrorTypeTitleDetailStatus
object
4 properties
GetCollectionRequestInternalServerError
PutCollectionRequestNotFoundError
createCollectionSchema
object
6 properties
2 required
Request2BodyGraphql
object
If the mode value is graphql, an object containing the GraphQL request information.
2 properties
GetCollectionPullRequestsDataItems
object
Information about the pull request.
12 properties
UpdateCollectionRolesRolesItemsPath
string
The resource to perform the action on.
environmentVariableSource
object
Information about the source of the variable's value.
2 properties
PutCollectionRequestForbiddenError
GetCollectionsForkedByUserRequestUnauthorizedError
response-2
object
Information about the request's response.
10 properties
PatchCollectionResponseCollection
object
3 properties
GetSourceCollectionStatusRequestInternalServerError
Fork400ErrorNoUserFoundError
object
2 properties
PatchCollectionCollection
The collection updates to apply. You must pass at least one of the following: info, variable, auth, or events. Unsupported properties are rejected.
createCollectionFork
object
1 property
1 required
MergeCollectionForkResponseCollection
object
2 properties
transferCollectionItems
object
4 properties
4 required
GetDuplicateCollectionTaskStatusRequestForbiddenError
GetCollectionCollectionInfoFork
object
If the collection was forked from another collection, this object contains information about the fork.
3 properties
AsyncMergePullCollectionForkRequestUnauthorizedError
TransferCollectionItemsLocationPosition
string
The transferred item's position within the destination object.
PatchCollectionRequestBadRequestError
Event2Listen
string
The prerequest (pre-request) or test (post-response) value.
UrlOneOf1QueryItems
object
4 properties
commentCreate
object
Information about the comment.
3 properties
1 required
RequestBodyFormdataItemsOneOf1Type
string
The file value.
EnvironmentVariableSourcePostman
object
Information about the Postman-specific source of the variable's value.
3 properties
GetCollectionForksRequestInternalServerError
getCollectionForks
object
2 properties
mergeCollectionForkResponse
object
1 property
PullCollectionChangesResponseCollection
object
Information about the updated collection fork.
2 properties
commentResponse
object
1 property
item-2
object
Information about the collection request or folder.
11 properties
1 required
GetCollectionRolesUserItems
object
Information about the user role.
2 properties
DocumentationApperanceSettingsDefault
string
The default color theme (light or dark). Documentation uses the given theme value by default.
Request2BodyFormdataItems0
object
5 properties
Request2BodyFormdataItems1
object
5 properties
createCollectionForkResponse
object
1 property
getSourceCollectionStatus
object
1 property
collectionNameQuery
string
Variable
object
A Postman variable with key-value pair and type.
4 properties
RequestListItem
object
5 properties
CollectionInput
object
Input format for creating or updating a collection.
5 properties
1 required
PaginationMeta
object
3 properties
CollectionItem
object
A request or folder within a collection.
6 properties
Auth
object
Authentication configuration for requests.
1 property
Event
object
A script event (pre-request or test).
2 properties
Collection
object
Full collection definition including requests, folders, and metadata.
5 properties
CollectionListItem
object
Abbreviated collection information returned in list responses.
8 properties
ResponseListItem
object
4 properties
FolderListItem
object
4 properties
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 MCP Server
Postman Flows
Postman Mocks API
Postman Analytics API
Postman API Catalog API
Postman Billing 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.