Postman collectionItems API is one of 51 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Collection Items. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
12 operations
across 6 paths,
and defines 90 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.
The identity and technical contract details declared by the specification.
updateCollectionRequest
object
The request properties to update. For a complete list of properties, refer to the Request property in the [Postman Collection Format documentation](https://sch…
13 properties
UpdateCollectionResponseRequestInternalServerError
createCollectionResponse
object
Information about the response. For a complete list of properties, refer to the Response entry in the [Postman Collection Format documentation](https://schema.…
17 properties
GetCollectionResponseData
object
Information about the response. For a complete list of properties, refer to the Response entry in the [Postman Collection Format documentation](https://schema.…
8 properties
GetCollectionFolderData
object
Information about the folder. For a complete list of properties, refer to the Folders entry in the [Postman Collection Format documentation](https://schema.pos…
9 properties
DeleteCollectionFolderRequestInternalServerError
createCollectionFolder
object
Information about the collection folder. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/c…
2 properties
UpdateCollectionResponseResponseCode
object
The response's HTTP response code information.
2 properties
UpdateCollectionFolderRequestInternalServerError
commonErrorNameMessage
object
1 property
RequestEventsItemsListen
string
The event type.
CommonErrorTypeTitleDetailStatusType
DeleteCollectionFolderData
object
The folder's information.
2 properties
request-auth
object
The request's authentication information.
13 properties
1 required
DeleteCollectionRequestRequestInternalServerError
RequestDataOptionsUrlencoded
object
Options for the urlencoded data mode.
deleteCollectionResponse
object
4 properties
CreateCollectionFolderResponseData
object
Information about the collection folder. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/c…
13 properties
CommonErrorNameMessageDetailsError
object
3 properties
getCollectionFolder
object
3 properties
CreateCollectionRequestResponseData
object
Information about the created request. For a complete list of properties, refer to the Request entry in the [Postman Collection Format documentation](https://s…
10 properties
CreateCollectionFolderRequestInternalServerError
updateCollectionResponse
object
The response properties to update. For a complete list of properties, refer to the Response entry in the [Postman Collection Format documentation](https://sche…
17 properties
CommonErrorNameMessageError
object
Information about the error.
2 properties
AuthAttributeValue
The key's value.
UpdateCollectionRequestRequestInternalServerError
RequestDataOptionsBinary
object
Options for the binary data mode.
collectionFolderId
string
CreateCollectionResponseResponseCode
object
The response's HTTP response code information.
2 properties
createCollectionFolderResponse
object
4 properties
UpdateCollectionResponseResponseData
object
Information about the updated response. For a complete list of response properties, refer to the Response entry in the [Postman Collection Format documentation…
7 properties
GetCollectionRequestRequestInternalServerError
CreateCollectionResponseDataMode
string
The associated request body's data mode.
UpdateCollectionFolderResponseData
object
The folder's updated information, including the updated properties. For a complete list of properties, refer to the [Postman Collection Format documentation](h…
10 properties
CreateCollectionRequestDataMode
string
The request body's data mode.
request-method
string
The request's HTTP method.
RequestDataItemsType
string
The form data's type.
request-graphql-mode-data
object
The request body's GraphQL mode data.
2 properties
AuthAttributeValue1
array
request-data-options
object
Additional configurations and options set for the request body's various data modes.
5 properties
UpdateCollectionRequestDataMode
string
The request body's data mode.
RequestDataOptionsParams
object
Options for the params data mode.
DeleteCollectionResponseRequestInternalServerError
UpdateCollectionResponseDataMode
string
The associated request body's data mode.
RequestEventsItems
object
2 properties
AuthAttributeValueOneOf1Items
object
header-2
object
Information about the header.
3 properties
2 required
RequestAuthType
string
The authorization type.
commonErrorTypeTitleDetailStatus
object
4 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
deleteCollectionRequest
object
4 properties
header-list-2
array
A list of headers.
collectionResponseId
string
CreateCollectionRequestRequestInternalServerError
request-query-params
array
The request's query parameters.
UpdateCollectionRequestResponseData
object
Information about the updated request. For a complete list of properties, refer to the Request entry in the [Postman Collection Format documentation](https://s…
8 properties
updateCollectionRequestResponse
object
4 properties
AuthAttributeType
string
The value's type.
request-header-data
array
The request's headers.
createCollectionResponseResponse
object
4 properties
request-events
array
A list of scripts configured to run when specific events occur.
RequestQueryParamsItems
object
4 properties
GetCollectionFolderRequestInternalServerError
script-2
object
Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
3 properties
updateCollectionFolderResponse
object
4 properties
collectionRequestId
string
DeleteCollectionResponseData
object
The response's information.
2 properties
GetCollectionResponseRequestInternalServerError
createCollectionRequest
object
Information about the request. For a complete list of properties, refer to the Request property in the [Postman Collection Format documentation](https://schema…
13 properties
commonErrorNameMessageDetails
object
1 property
commonErrorTypeTitleDetail
object
3 properties
RequestDataItems
object
6 properties
CommonErrorTypeTitleDetailDetail
Information about the error.
CommonErrorNameMessageDetailsErrorDetails
Information about the error.
request-data
array
The request body's form data.
createCollectionRequestResponse
object
4 properties
updateCollectionResponseResponse
object
3 properties
CreateCollectionResponseRequestInternalServerError
RequestDataOptionsGraphql
object
Options for the graphql data mode.
updateCollectionFolder
object
The folder properties to update. For a complete list of properties, refer to the [Postman Collection Format documentation](https://schema.postman.com/collectio…
2 properties
CreateCollectionResponseResponseData
object
Information about the response. For a complete list of properties, refer to the Response entry in the [Postman Collection Format documentation](https://schema.…
6 properties
GetCollectionRequestData
object
Information about the request. For a complete list of properties, refer to the Request entry in the [Postman Collection Format documentation](https://schema.po…
7 properties
getCollectionResponse
object
3 properties
RequestDataOptionsRaw
object
Options for the raw data mode.
1 property
DeleteCollectionRequestData
object
The request's information.
2 properties
RequestHeaderDataItems
object
3 properties
getCollectionRequest
object
3 properties
deleteCollectionFolder
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Postman publishes across the network.
