Get a collection

Deprecated

GET

/apis/:apiId/collections/:collectionId

GET

/apis/:apiId/collections/:collectionId

$ curl https://api.postman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/collections/12345678-61867bcc-c4c1-11ed-afa1-0242ac120002 \
>      -H "Accept: application/vnd.api.v10+json" \
>      -H "x-api-key: <apiKey>"

1 {
2   "item": [
3     {
4       "id": "d3779255-5293-4e58-9b65-8954936e1dca",
5       "name": "Read a spacecraft",
6       "protocolProfileBehavior": {
7         "disableBodyPruning": true
8       },
9       "request": {
10         "header": [
11           {
12             "key": "Accept",
13             "value": "application/json"
14           }
15         ],
16         "method": "GET",
17         "url": {
18           "host": [
19             "https://api.postman.com"
20           ],
21           "path": [
22             "spacecrafts",
23             ":spacecraftId"
24           ],
25           "raw": "https://api.postman.com/spacecrafts/:spacecraftId",
26           "variable": [
27             {
28               "description": "(Required) The unique identifier of the spacecraft",
29               "key": "spacecraftId",
30               "value": "<string>"
31             }
32           ]
33         }
34       },
35       "response": [
36         {
37           "_postman_previewlanguage": "json",
38           "_postman_previewtype": "html",
39           "body": "{\n  \"id\": \"<string>\",\n  \"name\": \"commodo\",\n  \"type\": \"capsule\",\n  \"description\": \"pariatur dolo\"\n}",
40           "code": 200,
41           "cookie": [],
42           "header": [
43             {
44               "key": "Content-Type",
45               "value": "application/json"
46             }
47           ],
48           "id": "54467f6e-71d7-43d5-acc0-48f948e38528",
49           "name": "The spacecraft corresponding to the provided `spacecraftId`",
50           "originalRequest": {
51             "header": [
52               {
53                 "description": "Added as a part of security scheme: apikey",
54                 "key": "X-Api-Key",
55                 "value": "<API Key>"
56               }
57             ],
58             "method": "GET",
59             "url": {
60               "host": [
61                 "https://api.postman.com"
62               ],
63               "path": [
64                 "spacecrafts",
65                 ":spacecraftId"
66               ],
67               "raw": "https://api.postman.com/spacecrafts/:spacecraftId",
68               "variable": [
69                 {
70                   "description": "(Required) The unique identifier of the spacecraft",
71                   "key": "spacecraftId",
72                   "value": "<string>"
73                 }
74               ]
75             }
76           },
77           "responseTime": null,
78           "status": "OK"
79         },
80         {
81           "_postman_previewlanguage": "json",
82           "_postman_previewtype": "html",
83           "body": "{\n  \"message\": \"dolore Excepteur\"\n}",
84           "code": 404,
85           "cookie": [],
86           "header": [
87             {
88               "key": "Content-Type",
89               "value": "application/json"
90             }
91           ],
92           "id": "1231609a-7a3d-444d-aa0c-579703e618f4",
93           "name": "No spacecraft found for the provided `spacecraftId`",
94           "originalRequest": {
95             "header": [
96               {
97                 "description": "Added as a part of security scheme: apikey",
98                 "key": "X-Api-Key",
99                 "value": "<API Key>"
100               }
101             ],
102             "method": "GET",
103             "url": {
104               "host": [
105                 "https://api.postman.com"
106               ],
107               "path": [
108                 "spacecrafts",
109                 ":spacecraftId"
110               ],
111               "raw": "https://api.postman.com/spacecrafts/:spacecraftId",
112               "variable": [
113                 {
114                   "description": "(Required) The unique identifier of the spacecraft",
115                   "key": "spacecraftId",
116                   "value": "<string>"
117                 }
118               ]
119             }
120           },
121           "responseTime": null,
122           "status": "Not Found"
123         },
124         {
125           "_postman_previewlanguage": "json",
126           "_postman_previewtype": "html",
127           "body": "{\n  \"message\": \"dolore Excepteur\"\n}",
128           "code": 500,
129           "cookie": [],
130           "header": [
131             {
132               "key": "Content-Type",
133               "value": "application/json"
134             }
135           ],
136           "id": "db674465-8cec-4208-9724-42278ca9b83c",
137           "name": "Unexpected error",
138           "originalRequest": {
139             "header": [
140               {
141                 "description": "Added as a part of security scheme: apikey",
142                 "key": "X-Api-Key",
143                 "value": "<API Key>"
144               }
145             ],
146             "method": "GET",
147             "url": {
148               "host": [
149                 "https://api.postman.com"
150               ],
151               "path": [
152                 "spacecrafts",
153                 ":spacecraftId"
154               ],
155               "raw": "https://api.postman.com/spacecrafts/:spacecraftId",
156               "variable": [
157                 {
158                   "description": "(Required) The unique identifier of the spacecraft",
159                   "key": "spacecraftId",
160                   "value": "<string>"
161                 }
162               ]
163             }
164           },
165           "responseTime": null,
166           "status": "Internal Server Error"
167         }
168       ]
169     }
170   ],
171   "info": {
172     "name": "Generated",
173     "schema": "https://schema.postman.com/json/collection/v2.1.0/collection.json",
174     "_postman_id": "e726de58-f1b3-4edd-a8a7-2579dc799d39",
175     "description": "Buy or rent spacecrafts"
176   },
177   "auth": {
178     "apikey": [
179       {
180         "key": "key",
181         "value": "X-Api-Key"
182       },
183       {
184         "key": "value",
185         "value": "{{apiKey}}"
186       },
187       {
188         "key": "in",
189         "value": "header"
190       }
191     ],
192     "type": "apikey"
193   },
194   "variable": [
195     {
196       "id": "526a20ba-acfb-4549-a841-8edf2d24b929",
197       "key": "baseUrl",
198       "type": "string",
199       "value": "/"
200     }
201   ]
202 }

Gets a collection attached to an API. You can use the versionId query parameter to get a collection published in a version.

Note:

You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers.
You can get a collection published in an API version with the versionId query parameter.
The versionId query parameter is a required parameter for API viewers.

Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published in a version. **Note:** - You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers. - You can get a collection published in an API version with the `versionId` query parameter. - The `versionId` query parameter is a required parameter for API viewers.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

apiIdstringRequired

The API's ID.

collectionIdstringRequiredformat: "uid"

The collection's unique ID.

Query parameters

versionIdstringOptional

The API's version ID. This is a required parameter for API viewers.

Response

Successful Response

itemlist of maps from strings to any

A list of the collection's contents.

infoobject

Information about the collection.

authmap from strings to any

The collection’s auth information. For a complete list of values, refer to the Auth entry in the Postman Collection Format documentation.

variablelist of maps from strings to any

A list of the collection's variables.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors