Get a collection

GET

/collections/:collectionId

GET

/collections/:collectionId

$ curl https://api.getpostman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2 \
>      -H "x-api-key: <apiKey>"

1 {
2   "collection": {
3     "info": {
4       "_postman_id": "12ece9e1-2abf-4edc-8e34-de66e74114d2",
5       "name": "Test Collection",
6       "description": "This is a test.",
7       "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
8       "updatedAt": "2023-10-09T18:34:58.000Z",
9       "uid": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
10       "createdAt": "2023-10-09T18:34:58.000Z",
11       "lastUpdatedBy": "12345678"
12     },
13     "item": [
14       {
15         "id": "c9a0e43c-6078-4fa0-8cfc-d4dc9e889817",
16         "name": "Folder 1",
17         "description": "This is a test folder.",
18         "event": [
19           {
20             "listen": "prerequest",
21             "script": {
22               "type": "text/javascript",
23               "exec": [
24                 "pm.variables.get(\"variable_key\");"
25               ]
26             }
27           },
28           {
29             "listen": "test",
30             "script": {
31               "type": "text/javascript",
32               "exec": [
33                 "pm.test(\"Status code is 200\", function () {",
34                 "    pm.response.to.have.status(200);",
35                 "});"
36               ]
37             }
38           }
39         ],
40         "createdAt": "2022-10-05T13:09:28.000Z",
41         "updatedAt": "2023-09-13T14:32:34.000Z",
42         "uid": "12345678-c9a0e43c-6078-4fa0-8cfc-d4dc9e889817",
43         "auth": {
44           "apikey": [
45             {
46               "key": "value",
47               "type": "string",
48               "value": "XXX"
49             },
50             {
51               "key": "key",
52               "type": "string",
53               "value": "x-api-key"
54             }
55           ],
56           "type": "apikey"
57         },
58         "item": [
59           {
60             "auth": {
61               "apikey": [
62                 {
63                   "key": "value",
64                   "type": "string",
65                   "value": "XXX"
66                 },
67                 {
68                   "key": "key",
69                   "type": "string",
70                   "value": "api-key"
71                 }
72               ],
73               "type": "apikey"
74             },
75             "createdAt": "2023-09-12T15:46:34.000Z",
76             "event": [
77               {
78                 "listen": "prerequest",
79                 "script": {
80                   "exec": [
81                     "pm.sendRequest(\"https://postman-echo.com/get\", function (err, response) {",
82                     "    console.log(response.json());",
83                     "});"
84                   ],
85                   "type": "text/javascript"
86                 }
87               },
88               {
89                 "listen": "test",
90                 "script": {
91                   "exec": [
92                     "pm.test(\"Status code is 200\", function () {",
93                     "    pm.response.to.have.status(200);",
94                     "});"
95                   ],
96                   "type": "text/javascript"
97                 }
98               }
99             ],
100             "id": "a7046e3e-fb60-44fc-8e32-a4578b854628",
101             "item": [
102               {
103                 "createdAt": "2023-08-22T12:52:01.000Z",
104                 "event": [
105                   {
106                     "listen": "prerequest",
107                     "script": {
108                       "exec": [
109                         "pm.sendRequest(\"https://postman-echo.com/get\", function (err, response) {",
110                         "    console.log(response.json());",
111                         "});"
112                       ],
113                       "type": "text/javascript"
114                     }
115                   },
116                   {
117                     "listen": "test",
118                     "script": {
119                       "exec": [
120                         "pm.test(\"Status code is 200\", function () {",
121                         "    pm.response.to.have.status(200);",
122                         "});"
123                       ],
124                       "type": "text/javascript"
125                     }
126                   }
127                 ],
128                 "id": "c616506e-0676-4d79-88a7-c273b70e9cea",
129                 "name": "Test D",
130                 "protocolProfileBehavior": {
131                   "disableBodyPruning": true
132                 },
133                 "request": {
134                   "auth": {
135                     "apikey": [
136                       {
137                         "key": "value",
138                         "type": "string",
139                         "value": "XXX"
140                       },
141                       {
142                         "key": "key",
143                         "type": "string",
144                         "value": "api-key"
145                       }
146                     ],
147                     "type": "apikey"
148                   },
149                   "description": "This is an example GET request.",
150                   "header": [],
151                   "method": "GET",
152                   "url": {
153                     "host": [
154                       "postman-echo",
155                       "com"
156                     ],
157                     "path": [
158                       "get"
159                     ],
160                     "protocol": "https",
161                     "query": [
162                       {
163                         "description": "Optional. The user's ID.",
164                         "key": "id",
165                         "value": "12345678"
166                       }
167                     ],
168                     "raw": "https://postman-echo.com/get?id=12345678"
169                   }
170                 },
171                 "response": [
172                   {
173                     "_postman_previewlanguage": "json",
174                     "body": "{\n    \"id\": \"1234\",\n    \"user\": \"test-user\",\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\"\n}",
175                     "code": 200,
176                     "cookie": [],
177                     "createdAt": "2023-08-22T12:52:01.000Z",
178                     "header": [
179                       {
180                         "description": "",
181                         "key": "Content-Type",
182                         "name": "Content-Type",
183                         "type": "text",
184                         "value": "application/json"
185                       }
186                     ],
187                     "id": "d20b9562-9c85-4f25-bb2d-cfacf7dd85d1",
188                     "name": "Successful Response",
189                     "originalRequest": {
190                       "header": [
191                         {
192                           "key": "Content-Type",
193                           "name": "Content-Type",
194                           "type": "text",
195                           "value": "application/json"
196                         }
197                       ],
198                       "method": "GET",
199                       "url": {
200                         "host": [
201                           "postman-echo",
202                           "com"
203                         ],
204                         "path": [
205                           "get"
206                         ],
207                         "protocol": "https",
208                         "query": [
209                           {
210                             "description": "Optional. The user's ID.",
211                             "key": "id",
212                             "value": "1234"
213                           }
214                         ],
215                         "raw": "https://postman-echo.com/get?id=1234"
216                       }
217                     },
218                     "responseTime": null,
219                     "status": "OK",
220                     "uid": "12345678-d20b9562-9c85-4f25-bb2d-cfacf7dd85d1",
221                     "updatedAt": "2023-09-13T14:31:25.000Z"
222                   }
223                 ],
224                 "uid": "12345678-c616506e-0676-4d79-88a7-c273b70e9cea",
225                 "updatedAt": "2023-09-13T14:31:25.000Z"
226               },
227               {
228                 "createdAt": "2023-09-13T14:05:22.000Z",
229                 "id": "bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5",
230                 "name": "Test E",
231                 "protocolProfileBehavior": {
232                   "disableBodyPruning": true
233                 },
234                 "request": {
235                   "auth": {
236                     "bearer": [
237                       {
238                         "key": "token",
239                         "type": "string",
240                         "value": "TEST"
241                       }
242                     ],
243                     "type": "bearer"
244                   },
245                   "body": {
246                     "mode": "raw",
247                     "options": {
248                       "raw": {
249                         "language": "json"
250                       }
251                     },
252                     "raw": "{\n    \"username\": \"test-user\",\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\"\n}"
253                   },
254                   "description": "This is an example GET request.",
255                   "header": [],
256                   "method": "PATCH",
257                   "url": {
258                     "host": [
259                       "postman-echo",
260                       "com"
261                     ],
262                     "path": [
263                       "get"
264                     ],
265                     "protocol": "https",
266                     "query": [
267                       {
268                         "description": "Optional. The user's ID.",
269                         "key": "id",
270                         "value": "12345678"
271                       }
272                     ],
273                     "raw": "https://postman-echo.com/get?id=12345678"
274                   }
275                 },
276                 "response": [
277                   {
278                     "_postman_previewlanguage": "json",
279                     "body": "{\n    \"id\": \"1234\",\n    \"user\": \"test-user\"\n}",
280                     "code": 200,
281                     "cookie": [],
282                     "createdAt": "2023-09-13T14:05:22.000Z",
283                     "header": [
284                       {
285                         "description": "",
286                         "key": "Content-Type",
287                         "name": "Content-Type",
288                         "type": "text",
289                         "value": "application/json"
290                       }
291                     ],
292                     "id": "86447cb0-aeac-4371-a22f-9f6067fc4dd0",
293                     "name": "Successful Response",
294                     "originalRequest": {
295                       "body": {
296                         "mode": "raw",
297                         "options": {
298                           "raw": {
299                             "language": "json"
300                           }
301                         },
302                         "raw": "{\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\"\n}"
303                       },
304                       "header": [
305                         {
306                           "key": "Content-Type",
307                           "name": "Content-Type",
308                           "type": "text",
309                           "value": "application/json"
310                         }
311                       ],
312                       "method": "GET",
313                       "url": {
314                         "host": [
315                           "postman-echo",
316                           "com"
317                         ],
318                         "path": [
319                           "get"
320                         ],
321                         "protocol": "https",
322                         "query": [
323                           {
324                             "description": "Optional. The user's ID.",
325                             "key": "id",
326                             "value": "1234"
327                           }
328                         ],
329                         "raw": "https://postman-echo.com/get?id=1234"
330                       }
331                     },
332                     "responseTime": null,
333                     "status": "OK",
334                     "uid": "12345678-86447cb0-aeac-4371-a22f-9f6067fc4dd0",
335                     "updatedAt": "2023-09-13T14:13:21.000Z"
336                   }
337                 ],
338                 "uid": "12345678-bf6fd735-125e-486b-b7fb-9f0ae4a0bbc5",
339                 "updatedAt": "2023-09-13T14:14:41.000Z"
340               }
341             ],
342             "name": "ID",
343             "uid": "12345678-a7046e3e-fb60-44fc-8e32-a4578b854628",
344             "updatedAt": "2023-09-13T14:05:22.000Z"
345           },
346           {
347             "createdAt": "2022-10-05T13:09:24.000Z",
348             "event": [
349               {
350                 "listen": "test",
351                 "script": {
352                   "exec": [
353                     "pm.test(\"Status code is 200\", function () {",
354                     "    pm.response.to.have.status(200);",
355                     "});"
356                   ],
357                   "type": "text/javascript"
358                 }
359               },
360               {
361                 "listen": "prerequest",
362                 "script": {
363                   "exec": [
364                     "pm.sendRequest(\"https://postman-echo.com/get\", function (err, response) {",
365                     "    console.log(response.json());",
366                     "});"
367                   ],
368                   "type": "text/javascript"
369                 }
370               }
371             ],
372             "id": "bb4a826b-1654-4f24-9ab1-d00e4fc2d743",
373             "name": "Test A",
374             "protocolProfileBehavior": {
375               "disableBodyPruning": true
376             },
377             "request": {
378               "auth": {
379                 "bearer": [
380                   {
381                     "key": "token",
382                     "type": "string",
383                     "value": "TEST"
384                   }
385                 ],
386                 "type": "bearer"
387               },
388               "body": {
389                 "mode": "raw",
390                 "options": {
391                   "raw": {
392                     "language": "json"
393                   }
394                 },
395                 "raw": ""
396               },
397               "description": "This is a test API.",
398               "header": [
399                 {
400                   "key": "Accept",
401                   "type": "text",
402                   "value": "application/vnd.example.v1+json"
403                 }
404               ],
405               "method": "GET",
406               "url": {
407                 "host": [
408                   "api",
409                   "getpostman",
410                   "com"
411                 ],
412                 "path": [
413                   "v1",
414                   "request"
415                 ],
416                 "protocol": "http",
417                 "query": [
418                   {
419                     "description": "The API's ID.",
420                     "key": "id",
421                     "value": "12345678"
422                   }
423                 ],
424                 "raw": "http://api.getpostman.com/v1/request?id=12345678"
425               }
426             },
427             "response": [
428               {
429                 "_postman_previewlanguage": "json",
430                 "body": "{\n  \"args\": {},\n  \"data\": {\n    \"field\": \"Value\"\n  },\n  \"files\": {},\n  \"form\": {},\n  \"headers\": {\n    \"x-forwarded-proto\": \"https\",\n    \"x-forwarded-port\": \"443\",\n    \"host\": \"postman-echo.com\",\n    \"x-amzn-trace-id\": \"Root=1-64f9c517-36db304817c774d740619baa\",\n    \"content-length\": \"22\",\n    \"user-agent\": \"curl/7.88.1\",\n    \"accept\": \"*/*\",\n    \"content-type\": \"application/json\"\n  },\n  \"json\": {\n    \"field\": \"Value\"\n  },\n  \"url\": \"https://postman-echo.com/post\"\n}\n",
431                 "code": 200,
432                 "cookie": [],
433                 "createdAt": "2023-09-12T18:34:27.000Z",
434                 "header": [
435                   {
436                     "key": "date",
437                     "value": "Thu, 07 Sep 2023 12:41:59 GMT"
438                   },
439                   {
440                     "key": "content-type",
441                     "value": "application/json; charset=utf-8"
442                   },
443                   {
444                     "key": "content-length",
445                     "value": "468"
446                   },
447                   {
448                     "key": "etag",
449                     "value": "W/\"1d4-JuAIw8ssoFCtGzk/UwITxaiSbrc\""
450                   },
451                   {
452                     "key": "set-cookie",
453                     "value": "sails.sid=s%3A6p_NXpI3OZeGE35bI6i5Uq3XgHHxcsdJ.dQVpBE%2BJ9wHWainkqe6F6dkdv7UKoshSZY7sdZ5sbzo; Path=/ HttpOnly"
454                   }
455                 ],
456                 "id": "5f297469-80d7-4847-a3e2-f596f2e717d8",
457                 "name": "Successful Response",
458                 "originalRequest": {
459                   "body": {
460                     "mode": "raw",
461                     "options": {
462                       "raw": {
463                         "language": "json"
464                       }
465                     },
466                     "raw": "{\n  \"field\": \"Value\"\n}"
467                   },
468                   "header": [
469                     {
470                       "key": "Host",
471                       "value": "postman-echo.com"
472                     },
473                     {
474                       "key": "user-agent",
475                       "value": "curl/7.88.1"
476                     },
477                     {
478                       "key": "accept",
479                       "value": "*/*"
480                     },
481                     {
482                       "key": "content-type",
483                       "value": "application/json"
484                     },
485                     {
486                       "key": "content-length",
487                       "value": "22"
488                     }
489                   ],
490                   "method": "POST",
491                   "url": {
492                     "host": [
493                       "postman-echo",
494                       "com"
495                     ],
496                     "path": [
497                       "post"
498                     ],
499                     "protocol": "https",
500                     "raw": "https://postman-echo.com/post"
501                   }
502                 },
503                 "responseTime": null,
504                 "status": "OK",
505                 "uid": "12345678-5f297469-80d7-4847-a3e2-f596f2e717d8",
506                 "updatedAt": "2023-09-13T14:04:37.000Z"
507               },
508               {
509                 "_postman_previewlanguage": "json",
510                 "body": "{\n    \"title\": \"Not Found\",\n    \"detail\": \"Requested API does not exist\",\n    \"type\": \"about:blank\"\n}",
511                 "code": 404,
512                 "cookie": [],
513                 "createdAt": "2023-08-22T12:53:12.000Z",
514                 "header": [
515                   {
516                     "description": "",
517                     "key": "Content-Type",
518                     "name": "Content-Type",
519                     "type": "text",
520                     "value": "application/json"
521                   }
522                 ],
523                 "id": "789df3cf-9362-40f7-a69e-4adde47d2bc8",
524                 "name": "Not Found",
525                 "originalRequest": {
526                   "body": {
527                     "mode": "raw",
528                     "options": {
529                       "raw": {
530                         "language": "json"
531                       }
532                     },
533                     "raw": ""
534                   },
535                   "header": [
536                     {
537                       "key": "Accept",
538                       "type": "text",
539                       "value": "application/vnd.example.v1+json"
540                     }
541                   ],
542                   "method": "GET",
543                   "url": {
544                     "host": [
545                       "api",
546                       "getpostman",
547                       "com"
548                     ],
549                     "path": [
550                       "v1",
551                       "request"
552                     ],
553                     "protocol": "http",
554                     "query": [
555                       {
556                         "key": "id",
557                         "value": "test-api"
558                       }
559                     ],
560                     "raw": "http://api.getpostman.com/v1/request?id=test-api"
561                   }
562                 },
563                 "responseTime": null,
564                 "status": "Not Found",
565                 "uid": "12345678-789df3cf-9362-40f7-a69e-4adde47d2bc8",
566                 "updatedAt": "2023-09-13T14:04:32.000Z"
567               }
568             ],
569             "uid": "12345678-bb4a826b-1654-4f24-9ab1-d00e4fc2d743",
570             "updatedAt": "2025-04-25T17:29:16.000Z"
571           },
572           {
573             "createdAt": "2022-10-05T13:16:49.000Z",
574             "id": "3e2b5890-8fb9-4a73-bf7b-f0a161502513",
575             "name": "Test B",
576             "protocolProfileBehavior": {
577               "disableBodyPruning": true
578             },
579             "request": {
580               "body": {
581                 "mode": "raw",
582                 "options": {
583                   "raw": {
584                     "language": "json"
585                   }
586                 },
587                 "raw": "{\n    \"name\": \"Test\",\n    \"description\": \"This is a test.\"\n}"
588               },
589               "header": [],
590               "method": "PUT",
591               "url": {
592                 "host": [
593                   "api",
594                   "getpostman",
595                   "com"
596                 ],
597                 "path": [
598                   "v1",
599                   "request"
600                 ],
601                 "protocol": "http",
602                 "raw": "http://api.getpostman.com/v1/request"
603               }
604             },
605             "response": [
606               {
607                 "_postman_previewlanguage": "json",
608                 "body": "{\n    \"id\": \"1234\",\n    \"user\": \"test-user\"\n}",
609                 "code": 200,
610                 "cookie": [],
611                 "createdAt": "2023-09-12T15:20:20.000Z",
612                 "header": [
613                   {
614                     "description": "",
615                     "key": "Content-Type",
616                     "name": "Content-Type",
617                     "type": "text",
618                     "value": "application/json"
619                   }
620                 ],
621                 "id": "c7ffac80-0ab7-45da-a966-10bf469936db",
622                 "name": "Test B",
623                 "originalRequest": {
624                   "body": {
625                     "mode": "raw",
626                     "options": {
627                       "raw": {
628                         "language": "json"
629                       }
630                     },
631                     "raw": "{\n    \"firstName\": \"Test\",\n    \"lastName\": \"User\"\n}"
632                   },
633                   "header": [
634                     {
635                       "key": "Content-Type",
636                       "name": "Content-Type",
637                       "type": "text",
638                       "value": "application/json"
639                     }
640                   ],
641                   "method": "PUT",
642                   "url": {
643                     "host": [
644                       "api",
645                       "getpostman",
646                       "com"
647                     ],
648                     "path": [
649                       "v1",
650                       "request"
651                     ],
652                     "protocol": "http",
653                     "raw": "http://api.getpostman.com/v1/request"
654                   }
655                 },
656                 "responseTime": null,
657                 "status": "OK",
658                 "uid": "12345678-c7ffac80-0ab7-45da-a966-10bf469936db",
659                 "updatedAt": "2023-09-13T14:13:44.000Z"
660               }
661             ],
662             "uid": "12345678-3e2b5890-8fb9-4a73-bf7b-f0a161502513",
663             "updatedAt": "2023-09-13T14:08:04.000Z"
664           },
665           {
666             "createdAt": "2023-09-07T14:03:52.000Z",
667             "event": [
668               {
669                 "listen": "test",
670                 "script": {
671                   "exec": [
672                     "pm.test(\"Status code is 200\", function () {",
673                     "    pm.response.to.have.status(200);",
674                     "});"
675                   ],
676                   "type": "text/javascript"
677                 }
678               },
679               {
680                 "listen": "prerequest",
681                 "script": {
682                   "exec": [
683                     ""
684                   ],
685                   "type": "text/javascript"
686                 }
687               }
688             ],
689             "id": "98518f83-1da1-4d27-8253-432cc923dbae",
690             "name": "Test C",
691             "protocolProfileBehavior": {
692               "disableBodyPruning": true
693             },
694             "request": {
695               "auth": {
696                 "apikey": [
697                   {
698                     "key": "value",
699                     "type": "string",
700                     "value": "XXX"
701                   },
702                   {
703                     "key": "key",
704                     "type": "string",
705                     "value": "api-key"
706                   }
707                 ],
708                 "type": "apikey"
709               },
710               "body": {
711                 "mode": "raw",
712                 "options": {
713                   "raw": {
714                     "language": "json"
715                   }
716                 },
717                 "raw": "{\n    \"name\": \"Test API\",\n    \"description\": \"This is a test API.\"\n}"
718               },
719               "header": [],
720               "method": "POST",
721               "url": {
722                 "host": [
723                   "postman-echo",
724                   "com"
725                 ],
726                 "path": [
727                   "post"
728                 ],
729                 "protocol": "https",
730                 "raw": "https://postman-echo.com/post"
731               }
732             },
733             "response": [
734               {
735                 "_postman_previewlanguage": "json",
736                 "body": "{\n    \"id\": \"test-api\",\n    \"name\": \"Test API\",\n    \"description\": \"This is a test API.\",\n    \"is_public\": false,\n    \"created_at\": \"2022-01-28T11:50:56.000Z\",\n    \"updated_at\": \"2022-01-28T11:50:56.000Z\",\n    \"performance\": {\n        \"collection\": \"123e4567-e89b-12d3-a456-556642440000\",\n        \"environment\": \"123e4567-e89b-12d3-a456-556642440000\"\n    }\n}",
737                 "cookie": [],
738                 "createdAt": "2023-09-12T15:21:55.000Z",
739                 "header": [
740                   {
741                     "description": "",
742                     "key": "Content-Type",
743                     "name": "Content-Type",
744                     "type": "text",
745                     "value": "application/json"
746                   }
747                 ],
748                 "id": "bb3cb97c-619e-4c81-9a14-139efe81816c",
749                 "name": "Successful Response",
750                 "originalRequest": {
751                   "body": {
752                     "mode": "raw",
753                     "options": {
754                       "raw": {
755                         "language": "json"
756                       }
757                     },
758                     "raw": "{\n    \"name\": \"Test API\",\n    \"description\": \"This is a test API.\"\n}"
759                   },
760                   "header": [],
761                   "method": "POST",
762                   "url": {
763                     "host": [
764                       "postman-echo",
765                       "com"
766                     ],
767                     "path": [
768                       "post"
769                     ],
770                     "protocol": "https",
771                     "raw": "https://postman-echo.com/post"
772                   }
773                 },
774                 "responseTime": null,
775                 "uid": "12345678-bb3cb97c-619e-4c81-9a14-139efe81816c",
776                 "updatedAt": "2023-09-13T14:33:26.000Z"
777               }
778             ],
779             "uid": "12345678-98518f83-1da1-4d27-8253-432cc923dbae",
780             "updatedAt": "2023-09-13T14:26:58.000Z"
781           }
782         ]
783       },
784       {
785         "id": "7d1ea228-82fc-4887-833a-caf88d3182d5",
786         "name": "Folder 3",
787         "description": "This is a test folder.",
788         "event": [
789           {
790             "listen": "prerequest",
791             "script": {
792               "type": "text/javascript",
793               "exec": [
794                 "pm.sendRequest(\"https://postman-echo.com/get\", function (err, response) {",
795                 "    console.log(response.json());",
796                 "});"
797               ]
798             }
799           },
800           {
801             "listen": "test",
802             "script": {
803               "type": "text/javascript",
804               "exec": [
805                 "pm.test(\"Status code is 200\", function () {",
806                 "    pm.response.to.have.status(200);",
807                 "});"
808               ]
809             }
810           }
811         ],
812         "createdAt": "2022-10-05T13:09:34.000Z",
813         "updatedAt": "2023-09-15T18:22:13.000Z",
814         "uid": "12345678-7d1ea228-82fc-4887-833a-caf88d3182d5",
815         "auth": {
816           "apikey": [
817             {
818               "key": "value",
819               "type": "string",
820               "value": "XXX"
821             },
822             {
823               "key": "key",
824               "type": "string",
825               "value": "x-api-key"
826             }
827           ],
828           "type": "apikey"
829         },
830         "item": [
831           {
832             "createdAt": "2023-09-13T21:54:44.000Z",
833             "description": "Test folder user ID.",
834             "id": "07f106de-776e-4fd8-9fc1-dc72e4a06a00",
835             "item": [
836               {
837                 "createdAt": "2023-09-14T12:44:28.000Z",
838                 "id": "a22f41d5-32bf-4830-8731-10ad18e88874",
839                 "name": "Request 3-A",
840                 "protocolProfileBehavior": {
841                   "disableBodyPruning": true
842                 },
843                 "request": {
844                   "body": {
845                     "mode": "raw",
846                     "options": {
847                       "raw": {
848                         "language": "json"
849                       }
850                     },
851                     "raw": ""
852                   },
853                   "header": [],
854                   "method": "GET",
855                   "url": {
856                     "raw": ""
857                   }
858                 },
859                 "response": [],
860                 "uid": "12345678-a22f41d5-32bf-4830-8731-10ad18e88874",
861                 "updatedAt": "2023-09-15T16:25:21.000Z"
862               }
863             ],
864             "name": "ID",
865             "uid": "12345678-07f106de-776e-4fd8-9fc1-dc72e4a06a00",
866             "updatedAt": "2023-09-15T16:26:42.000Z"
867           },
868           {
869             "createdAt": "2023-09-13T21:56:35.000Z",
870             "description": "Test folder for user information.",
871             "id": "2c9de017-885f-4c1e-99bf-d10cd870fb0b",
872             "item": [
873               {
874                 "createdAt": "2023-09-14T14:02:27.000Z",
875                 "id": "69e1ed6c-9d7b-41cd-aff7-69a468cf8252",
876                 "name": "New Request",
877                 "protocolProfileBehavior": {
878                   "disableBodyPruning": true
879                 },
880                 "request": {
881                   "header": [],
882                   "method": "POST",
883                   "url": {
884                     "raw": ""
885                   }
886                 },
887                 "response": [],
888                 "uid": "12345678-69e1ed6c-9d7b-41cd-aff7-69a468cf8252",
889                 "updatedAt": "2023-09-14T14:02:59.000Z"
890               },
891               {
892                 "createdAt": "2023-09-14T14:02:49.000Z",
893                 "id": "8b50cfc3-6af3-446e-a607-8d05e38e1ce9",
894                 "name": "New Request",
895                 "protocolProfileBehavior": {
896                   "disableBodyPruning": true
897                 },
898                 "request": {
899                   "header": [],
900                   "method": "GET",
901                   "url": {
902                     "raw": ""
903                   }
904                 },
905                 "response": [],
906                 "uid": "12345678-8b50cfc3-6af3-446e-a607-8d05e38e1ce9",
907                 "updatedAt": "2023-09-14T14:02:49.000Z"
908               }
909             ],
910             "name": "User",
911             "uid": "12345678-2c9de017-885f-4c1e-99bf-d10cd870fb0b",
912             "updatedAt": "2023-09-15T16:26:54.000Z"
913           },
914           {
915             "createdAt": "2022-11-18T15:42:45.000Z",
916             "id": "8b29623b-9c9c-4fed-ab9e-85f64524977b",
917             "name": "Test A",
918             "protocolProfileBehavior": {
919               "disableBodyPruning": true
920             },
921             "request": {
922               "header": [],
923               "method": "GET",
924               "url": {
925                 "host": [
926                   "api",
927                   "getpostman",
928                   "com"
929                 ],
930                 "path": [
931                   "v1",
932                   "request"
933                 ],
934                 "protocol": "http",
935                 "raw": "http://api.getpostman.com/v1/request"
936               }
937             },
938             "response": [],
939             "uid": "12345678-8b29623b-9c9c-4fed-ab9e-85f64524977b",
940             "updatedAt": "2023-09-13T14:07:08.000Z"
941           }
942         ]
943       },
944       {
945         "id": "ff460862-473c-41b8-8be4-a493041c3351",
946         "name": "Test F",
947         "request": {
948           "url": {
949             "raw": ""
950           },
951           "method": "POST",
952           "header": []
953         },
954         "response": [],
955         "protocolProfileBehavior": {
956           "disableBodyPruning": true
957         },
958         "createdAt": "2023-08-22T12:51:45.000Z",
959         "updatedAt": "2025-05-29T16:04:09.000Z",
960         "uid": "12345678-ff460862-473c-41b8-8be4-a493041c3351"
961       }
962     ],
963     "auth": {
964       "type": "apikey",
965       "apikey": [
966         {
967           "key": "value",
968           "value": "abc123",
969           "type": "string"
970         },
971         {
972           "key": "key",
973           "value": "x-api-key",
974           "type": "string"
975         }
976       ]
977     },
978     "event": [
979       {
980         "listen": "prerequest",
981         "script": {
982           "id": "cc22c328-3dcc-46c1-a357-7e2f72f54cf6",
983           "type": "text/javascript",
984           "exec": [
985             "try {",
986             "    const response = await pm.sendRequest({",
987             "        url: \"https://postman-echo.com/get\",",
988             "        method: \"GET\"",
989             "    });",
990             "",
991             "    console.log(response.json());",
992             "} catch (err) {",
993             "    console.error(err);",
994             "}"
995           ],
996           "packages": {}
997         }
998       },
999       {
1000         "listen": "test",
1001         "script": {
1002           "id": "5db243ea-5022-4d08-a620-b8fb9d561af5",
1003           "type": "text/javascript",
1004           "exec": [
1005             "pm.test(\"Status code is 200\", function () {",
1006             "    pm.response.to.have.status(200);",
1007             "});"
1008           ],
1009           "packages": {}
1010         }
1011       }
1012     ],
1013     "variable": [
1014       {
1015         "key": "userId",
1016         "description": "The user's ID.",
1017         "value": "12345678",
1018         "disabled": true
1019       }
1020     ]
1021   }
1022 }

Gets information about a collection. For a complete list of this endpoint’s possible values, refer to the Postman Collection Format documentation.

Gets information about a collection. For a complete list of this endpoint's possible values, refer to the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

collectionIdstringRequired

The collection's ID.

Query parameters

access_keystringOptional

A collection’s read-only access key. Using this query parameter does not require an API key to call the endpoint.

modelenumOptional

Return a list of only the collection’s root-level request (rootLevelRequests) and folder (rootLevelFolders) IDs instead of the full collection element data.

Allowed values:

Response

Successful Response

collectionobject

For a complete list of this endpoint’s possible values, use the Postman Collection Format documentation.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error