> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt. For full content including API reference and SDK examples, see https://learning.postman.com/llms-full.txt. # Get a spec file GET https://api.getpostman.com/specs/{specId}/files/{filePath} Gets the contents of an API specification's file. Reference: https://learning.postman.com/api-docs/api-reference/specs/get-spec-file ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: Postman API version: 1.0.0 paths: /specs/{specId}/files/{filePath}: get: operationId: getSpecFile summary: Get a spec file description: Gets the contents of an API specification's file. tags: - specs parameters: - name: specId in: path description: The spec's ID. required: true schema: $ref: '#/components/schemas/specId' - name: filePath in: path description: The path to the file. required: true schema: $ref: '#/components/schemas/filePath' - name: x-api-key in: header required: true schema: type: string responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getSpecFile' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetSpecFileRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetSpecFileRequestInternalServerError' servers: - url: https://api.getpostman.com description: https://api.getpostman.com - url: https://api.eu.postman.com description: https://api.eu.postman.com components: schemas: specId: type: string title: specId filePath: type: string title: filePath GetSpecFileType: type: string enum: - ROOT - DEFAULT description: > 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. title: GetSpecFileType getSpecFile: type: object properties: id: type: string description: The file's ID. name: type: string description: The file's name. path: type: string description: The file's path. createdBy: type: integer description: The user ID of the user that created the file. updatedBy: type: integer description: The ID of the user who updated the file. createdAt: type: string format: date-time description: The date and time at which the file was created. updatedAt: type: string format: date-time description: The date and time at which the file was updated. type: $ref: '#/components/schemas/GetSpecFileType' description: > 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. content: type: string description: The file's stringified contents. description: Information about the API specification file. title: getSpecFile CommonErrorTypeTitleDetailStatusType: oneOf: - type: string format: uri-reference - type: string title: CommonErrorTypeTitleDetailStatusType commonErrorTypeTitleDetailStatus: type: object properties: type: $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType' title: type: string description: A short summary of the problem. detail: type: string description: Information about the error. status: type: integer description: The error's HTTP status code. title: commonErrorTypeTitleDetailStatus commonErrorTypeTitleDetailStatusInstance: type: object properties: type: type: string format: uri-reference description: >- The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem. title: type: string description: A short summary of the problem. detail: type: string description: An explanation about the problem. status: type: integer description: The HTTP status code generated by the origin server. instance: type: string description: >- The URI reference that identifies the specific occurrence of the problem. title: commonErrorTypeTitleDetailStatusInstance GetSpecFileRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' title: GetSpecFileRequestForbiddenError CommonErrorTypeTitleDetailDetail: oneOf: - type: string - type: object additionalProperties: description: Any type description: Information about the error. title: CommonErrorTypeTitleDetailDetail commonErrorTypeTitleDetail: type: object properties: type: type: string description: The type of error. title: type: string description: A short summary of the problem. detail: $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail' description: Information about the error. title: commonErrorTypeTitleDetail CommonErrorNameMessageError: type: object properties: name: type: string description: The error name. message: type: string description: The error message. description: Information about the error. title: CommonErrorNameMessageError commonErrorNameMessage: type: object properties: error: $ref: '#/components/schemas/CommonErrorNameMessageError' description: Information about the error. title: commonErrorNameMessage GetSpecFileRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetSpecFileRequestInternalServerError securitySchemes: PostmanApiKey: type: apiKey in: header name: x-api-key scimApiKey: type: apiKey in: header name: Authorization description: >- 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. basicAuth: type: http scheme: basic ``` ## Examples ### Successful Response **Response** ```json { "id": "3860602b-7a92-45a6-8b60-725ff7b453d5", "name": "index.json", "path": "index.json", "createdBy": 12345678, "updatedBy": 12345678, "createdAt": "2025-07-22T19:29:08.000Z", "updatedAt": "2025-07-22T19:29:57.000Z", "type": "ROOT", "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}" } ``` **SDK Code** ```python Successful Response import requests url = "https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Successful Response const url = 'https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Successful Response package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Successful Response require 'uri' require 'net/http' url = URI("https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Successful Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json") .header("x-api-key", "") .asString(); ``` ```php Successful Response request('GET', 'https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Successful Response using RestSharp; var client = new RestClient("https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Successful Response import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Nested Spec File **Response** ```json { "id": "edc9f9f1-c0df-4a9a-9b5b-d4c7359d92ab", "name": "spacecrafts.json", "path": "components/schemas/spacecrafts.json", "createdBy": 12345678, "updatedBy": 12345678, "createdAt": "2025-07-22T18:45:48.000Z", "updatedAt": "2025-07-22T18:47:03.000Z", "type": "DEFAULT", "content": "{\n \"SpacecraftId\": {\n \"description\": \"The unique identifier of a spacecraft\",\n \"type\": \"string\"\n },\n \"Spacecraft\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\",\n \"type\"\n ],\n \"properties\": {\n \"id\": {\n \"$ref\": \"../schemas/spacecrafts.json#/SpacecraftId\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"capsule\",\n \"probe\",\n \"satellite\",\n \"spaceplane\",\n \"station\"\n ]\n },\n \"description\": {\n \"type\": \"string\"\n }\n }\n },\n \"Error\": {\n \"type\": \"object\",\n \"required\": [\n \"message\"\n ],\n \"properties\": {\n \"message\": {\n \"description\": \"A human readable error message\",\n \"type\": \"string\"\n }\n }\n }\n}" } ``` **SDK Code** ```python Nested Spec File import requests url = "https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Nested Spec File const url = 'https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json'; const options = {method: 'GET', headers: {'x-api-key': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Nested Spec File package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Nested Spec File require 'uri' require 'net/http' url = URI("https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' response = http.request(request) puts response.read_body ``` ```java Nested Spec File import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json") .header("x-api-key", "") .asString(); ``` ```php Nested Spec File request('GET', 'https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json', [ 'headers' => [ 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Nested Spec File using RestSharp; var client = new RestClient("https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json"); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Nested Spec File import Foundation let headers = ["x-api-key": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getpostman.com/specs/73e15000-bc7a-4802-b80e-05fff18fd7f8/files/index.json")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```