Get a spec file

GET

/specs/:specId/files/:filePath

GET

/specs/:specId/files/:filePath

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

1 {
2   "id": "3860602b-7a92-45a6-8b60-725ff7b453d5",
3   "name": "index.json",
4   "path": "index.json",
5   "createdBy": 12345678,
6   "updatedBy": 12345678,
7   "createdAt": "2025-07-22T19:29:08.000Z",
8   "updatedAt": "2025-07-22T19:29:57.000Z",
9   "type": "ROOT",
10   "content": "{\n  \"openapi\": \"3.0.0\",\n  \"info\": {\n    \"version\": \"1.0.0\",\n    \"title\": \"Sample API\",\n    \"description\": \"Buy or rent spacecrafts\",\n    \"contact\": {\n      \"name\": \"Taylor Lee\"\n    }\n  },\n  \"servers\": [\n    {\n      \"url\": \"https://example.com\"\n    }\n  ],\n  \"security\": [\n    {\n      \"ApiKey\": []\n    }\n  ],\n  \"paths\": {\n    \"/spacecrafts/{spacecraftId}\": {\n      \"parameters\": [\n        {\n          \"$ref\": \"./components/parameters/spacecrafts.json#/SpacecraftId\"\n        }\n      ],\n      \"get\": {\n        \"summary\": \"Read a spacecraft\",\n        \"description\": \"Gets information about a spacecraft.\",\n        \"operationId\": \"getSpacecraft\",\n        \"tags\": [\n          \"Spacecrafts\"\n        ],\n        \"responses\": {\n          \"200\": {\n            \"$ref\": \"./components/responses/spacecrafts.json#/SuccessfulResponse\"\n          },\n          \"404\": {\n            \"$ref\": \"./components/responses/spacecrafts.json#/NotFound\"\n          },\n          \"500\": {\n            \"description\": \"Unexpected error\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"$ref\": \"./components/schemas/spacecrafts.json#/Error\"\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  },\n  \"tags\": [\n    {\n      \"name\": \"Spacecrafts\"\n    }\n  ],\n  \"components\": {\n    \"securitySchemes\": {\n      \"ApiKey\": {\n        \"type\": \"apiKey\",\n        \"in\": \"header\",\n        \"name\": \"X-Api-Key\"\n      }\n    }\n  }\n}"
11 }

Gets the contents of an API specification's file.

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

specIdstringRequired

The spec's ID.

filePathstringRequired

The path to the file.

Response

Successful Response

idstring

The file's ID.

namestring

The file's name.

pathstring

The file's path.

createdByinteger

The user ID of the user that created the file.

updatedByinteger

The ID of the user who updated the file.

createdAtdatetime

The date and time at which the file was created.

updatedAtdatetime

The date and time at which the file was updated.

typeenum

The type of file:

ROOT — A file containing the full OpenAPI structure and references other (DEFAULT) spec files.
DEFAULT — A file referenced by the ROOT file.

contentstring

The file's stringified contents.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error