Postman API
  1. Collections
Postman API
  • API
    • Get all APIs
      GET
    • Create API
      POST
    • Delete an API
      DELETE
    • Single API
      GET
    • Update an API
      PUT
    • Get All API Versions
      GET
    • Create API Version
      POST
    • Delete an API Version
      DELETE
    • Get an API Version
      GET
    • Update an API Version
      PUT
    • Get contract test relations
      GET
    • Get documentation relations
      GET
    • Get environment relations
      GET
    • Get integration test relations
      GET
    • Get monitor relations
      GET
    • Get linked relations
      GET
    • Create relations
      POST
    • Create Schema
      POST
    • Get Schema
      GET
    • Update Schema
      PUT
    • Create collection from schema
      POST
    • Get test suite relations
      GET
    • Sync relations with schema
      PUT
  • Collections
    • All Collections
      GET
    • Create Collection
      POST
    • Create a Fork
      POST
    • Merge a Fork
      POST
    • Delete Collection
      DELETE
    • Single Collection
      GET
    • Update Collection
      PUT
  • Environments
    • All Environments
    • Create Environment
    • Delete Environment
    • Single Environment
    • Update Environment
  • Import
    • Import exported data
    • Import external API specification
  • User
    • API Key Owner
  • Mocks
    • All Mocks
    • Create Mock
    • Delete Mock
    • Single Mock
    • Update Mock
    • Publish Mock
    • Unpublish Mock
  • Monitors
    • All Monitors
    • Create Monitor
    • Delete Monitor
    • Single Monitor
    • Update Monitor
    • Run a Monitor
  • Webhooks
    • Create Webhook
  • Workspaces
    • All workspaces
    • Create Workspace
    • Delete Workspace
    • Single workspace
    • Update Workspace
  1. Collections

Single Collection

GET
/collections/{collection_uid}
Collections
Access the contents of a collection that is accessible to you using its unique id (uid).
Requires API Key as X-Api-Key request header or apikey URL query parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.getpostman.com/collections/'
Response Response Example
{
    "collection": {
        "info": {
            "_postman_id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3",
            "description": "This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.",
            "name": "Sample Collection",
            "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
        },
        "item": [
            {
                "event": [
                    {
                        "listen": "test",
                        "script": {
                            "exec": "var responseJSON;\ntry {\n    tests[\"Body contains headers\"] = responseBody.has(\"headers\");\n    responseJSON = JSON.parse(responseBody);\n    tests[\"Header contains host\"] = \"host\" in responseJSON.headers;\n    tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;\n}\ncatch (e) { }\n\n\n\n",
                            "type": "text/javascript"
                        }
                    }
                ],
                "id": "82ee981b-e19f-962a-401e-ea34ebfb4848",
                "name": "Request Headers",
                "request": {
                    "body": {
                        "formdata": [],
                        "mode": "formdata"
                    },
                    "description": "",
                    "header": [
                        {
                            "description": "",
                            "key": "my-sample-header",
                            "value": "Lorem ipsum dolor sit amet"
                        }
                    ],
                    "method": "GET",
                    "url": "https://echo.getpostman.com/headers"
                },
                "response": []
            }
        ],
        "variables": []
    }
}

Request

Path Params
collection_uid
string 
required

Responses

🟢200Valid Response
application/json
Body
collection
object 
optional
info
object 
optional
item
array [object {5}] 
optional
variables
array
optional
Previous
Delete Collection
Next
Update Collection
Built with