Get a spec's files

GET

/specs/:specId/files

GET

/specs/:specId/files

$ curl https://api.postman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files \
>      -H "x-api-key: <apiKey>"

1 {
2   "files": [
3     {
4       "id": "7224f35c-d4d4-4e6e-8d73-21255ba87c0a",
5       "path": "components/parameters/spacecrafts.json",
6       "name": "spacecrafts.json",
7       "createdBy": 12345678,
8       "updatedBy": 12345678,
9       "createdAt": "2025-07-22T18:46:25.000Z",
10       "updatedAt": "2025-07-22T18:48:39.000Z",
11       "type": "DEFAULT"
12     },
13     {
14       "id": "2e83adf5-5a2a-412f-b81a-3d83b1705681",
15       "path": "components/responses/spacecrafts.json",
16       "name": "spacecrafts.json",
17       "createdBy": 12345678,
18       "updatedBy": 12345678,
19       "createdAt": "2025-07-22T18:46:18.000Z",
20       "updatedAt": "2025-07-22T18:48:12.000Z",
21       "type": "DEFAULT"
22     },
23     {
24       "id": "edc9f9f1-c0df-4a9a-9b5b-d4c7359d92ab",
25       "path": "components/schemas/spacecrafts.json",
26       "name": "spacecrafts.json",
27       "createdBy": 12345678,
28       "updatedBy": 12345678,
29       "createdAt": "2025-07-22T18:45:48.000Z",
30       "updatedAt": "2025-07-22T18:47:03.000Z",
31       "type": "DEFAULT"
32     },
33     {
34       "id": "3860602b-7a92-45a6-8b60-725ff7b453d5",
35       "path": "index.json",
36       "name": "index.json",
37       "createdBy": 12345678,
38       "updatedBy": 12345678,
39       "createdAt": "2025-07-22T18:42:18.000Z",
40       "updatedAt": "2025-07-22T18:47:32.000Z",
41       "type": "ROOT"
42     }
43   ],
44   "meta": {
45     "nextCursor": "VGh1IE1hciAxNiAyMDIzIDE3OjIxOjUzIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSk="
46   }
47 }

Gets all the files in an API specification.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

specIdstringRequired

The spec's ID.

Response

Successful Response

fileslist of objects

A list of the API specification's files.

metaobject

The response's meta information for paginated results.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error