{ "opencollection": "1.0.0", "info": { "name": "Postman Collection Items API", "version": "1.0.0" }, "items": [ { "info": { "name": "collectionItems", "type": "folder" }, "items": [ { "info": { "name": "Create a folder", "type": "http" }, "http": { "method": "POST", "url": "https://api.postman.com/collections/:collectionId/folders", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\nYou can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the `requests` field and the list of request objects in the request body. For more information, see the provided example.\n\n**Note:**\n\nIt is recommended that you pa" }, { "info": { "name": "Create a request", "type": "http" }, "http": { "method": "POST", "url": "https://api.postman.com/collections/:collectionId/requests", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." }, { "name": "folderId", "value": "", "type": "query", "description": "The folder ID in which to create the request. By default, the system will create the request at the collection level." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\nIt is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.\n" }, { "info": { "name": "Create a response", "type": "http" }, "http": { "method": "POST", "url": "https://api.postman.com/collections/:collectionId/responses", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." }, { "name": "request", "value": "", "type": "query", "description": "The parent request's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a request response in a collection. For a complete list of request body properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\nIt is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.\n" }, { "info": { "name": "Get a folder", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/collections/:collectionId/folders/:folderId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "folderId", "value": "", "type": "path", "description": "The folder's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." }, { "name": "ids", "value": "", "type": "query", "description": "If true, returns only properties that contain ID values in the response." }, { "name": "uid", "value": "", "type": "query", "description": "If true, returns all IDs in UID format (`userId`-`id`)." }, { "name": "populate", "value": "", "type": "query", "description": "If true, returns all of the collection item's contents." } ] }, "docs": "Gets information about a folder in a collection." }, { "info": { "name": "Update a folder", "type": "http" }, "http": { "method": "PUT", "url": "https://api.postman.com/collections/:collectionId/folders/:folderId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "folderId", "value": "", "type": "path", "description": "The folder's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\nThis endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name` property). The endpoint does not update the entire resource.\n" }, { "info": { "name": "Delete a folder", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.postman.com/collections/:collectionId/folders/:folderId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "folderId", "value": "", "type": "path", "description": "The folder's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ] }, "docs": "Deletes a folder in a collection." }, { "info": { "name": "Get a request", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/collections/:collectionId/requests/:requestId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The request's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." }, { "name": "ids", "value": "", "type": "query", "description": "If true, returns only properties that contain ID values in the response." }, { "name": "uid", "value": "", "type": "query", "description": "If true, returns all IDs in UID format (`userId`-`id`)." }, { "name": "populate", "value": "", "type": "query", "description": "If true, returns all of the collection item's contents." } ] }, "docs": "Gets information about a request in a collection." }, { "info": { "name": "Update a request", "type": "http" }, "http": { "method": "PUT", "url": "https://api.postman.com/collections/:collectionId/requests/:requestId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The request's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\n- You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.\n- This endpoint does not support changing the folder of a request.\n" }, { "info": { "name": "Delete a request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.postman.com/collections/:collectionId/requests/:requestId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The request's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ] }, "docs": "Deletes a request in a collection." }, { "info": { "name": "Get a response", "type": "http" }, "http": { "method": "GET", "url": "https://api.postman.com/collections/:collectionId/responses/:responseId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "responseId", "value": "", "type": "path", "description": "The response's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." }, { "name": "ids", "value": "", "type": "query", "description": "If true, returns only properties that contain ID values in the response." }, { "name": "uid", "value": "", "type": "query", "description": "If true, returns all IDs in UID format (`userId`-`id`)." }, { "name": "populate", "value": "", "type": "query", "description": "If true, returns all of the collection item's contents." } ] }, "docs": "Gets information about a response in a collection." }, { "info": { "name": "Update a response", "type": "http" }, "http": { "method": "PUT", "url": "https://api.postman.com/collections/:collectionId/responses/:responseId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "responseId", "value": "", "type": "path", "description": "The response's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\n- You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection UID (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.\n- This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the `name" }, { "info": { "name": "Delete a response", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.postman.com/collections/:collectionId/responses/:responseId", "headers": [ { "name": "x-api-key", "value": "" } ], "params": [ { "name": "responseId", "value": "", "type": "path", "description": "The response's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ] }, "docs": "Deletes a response in a collection." } ] } ], "bundled": true }