> 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 version GET https://api.getpostman.com/apis/{apiId}/versions/{versionId} Gets information about an API version. **Note:** - For API editors, this endpoint returns an HTTP `302 Found` status code when the version status is pending. It also returns the `/apis/{apiId}/tasks/{taskId}` task status response header. - For API viewers, this endpoint returns an HTTP `404 Not Found` when the version status is pending. Reference: https://learning.postman.com/api-docs/api-reference/api/get-api-version ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: Postman API version: 1.0.0 paths: /apis/{apiId}/versions/{versionId}: get: operationId: getApiVersion summary: Get a version description: > Gets information about an API version. **Note:** - For API editors, this endpoint returns an HTTP `302 Found` status code when the version status is pending. It also returns the `/apis/{apiId}/tasks/{taskId}` task status response header. - For API viewers, this endpoint returns an HTTP `404 Not Found` when the version status is pending. tags: - api parameters: - name: apiId in: path description: The API's ID. required: true schema: $ref: '#/components/schemas/apiId' - name: versionId in: path description: The API's version ID. required: true schema: $ref: '#/components/schemas/apiVersionId' - name: x-api-key in: header required: true schema: type: string - name: Accept in: header description: >- The `application/vnd.api.v10+json` request header required to use the endpoint. required: true schema: $ref: '#/components/schemas/v10Accept' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/getApiVersion' '400': description: Missing v10 Accept Header content: application/json: schema: $ref: '#/components/schemas/apiErrorNameMessage' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/GetApiVersionRequestForbiddenError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/GetApiVersionRequestNotFoundError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/GetApiVersionRequestInternalServerError' 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: apiId: type: string title: apiId apiVersionId: type: string title: apiVersionId v10Accept: type: string enum: - application/vnd.api.v10+json title: v10Accept GetApiVersionVersionSchemasItems: type: object properties: id: type: string description: The schema's ID. type: type: string description: The schema type. description: Information about the schema. title: GetApiVersionVersionSchemasItems GetApiVersionVersionCollectionsItems: type: object properties: id: type: string description: The collection's ID. type: type: string description: The collection's name. description: Information about the collection. title: GetApiVersionVersionCollectionsItems GetApiVersionVersion: type: object properties: id: type: string description: The version's ID. name: type: string description: The version's name. createdAt: type: string format: date-time description: The date and time at which the version was created. updatedAt: type: string format: date-time description: The date and time at which the version was last updated. releaseNotes: type: string description: The version's release notes. schemas: type: array items: $ref: '#/components/schemas/GetApiVersionVersionSchemasItems' description: A list of the API's schemas. collections: type: array items: $ref: '#/components/schemas/GetApiVersionVersionCollectionsItems' description: A list of the API's collections. description: Information about the API version. title: GetApiVersionVersion getApiVersion: type: object properties: version: $ref: '#/components/schemas/GetApiVersionVersion' description: Information about the API version. title: getApiVersion apiErrorNameMessage: type: object properties: name: type: string description: The error name. message: type: string description: The error message. title: apiErrorNameMessage 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 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 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 GetApiVersionRequestForbiddenError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetApiVersionRequestForbiddenError 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 CommonErrorErrorObjTypeTitleDetailError: type: object properties: type: type: string description: The type of error. title: type: string description: A short summary of the problem. detail: type: string description: Details about the error. description: Information about the error. title: CommonErrorErrorObjTypeTitleDetailError commonErrorErrorObjTypeTitleDetail: type: object properties: error: $ref: '#/components/schemas/CommonErrorErrorObjTypeTitleDetailError' description: Information about the error. title: commonErrorErrorObjTypeTitleDetail GetApiVersionRequestNotFoundError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail' title: GetApiVersionRequestNotFoundError GetApiVersionRequestInternalServerError: oneOf: - $ref: '#/components/schemas/commonErrorTypeTitleDetail' - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus' - $ref: '#/components/schemas/commonErrorNameMessage' title: GetApiVersionRequestInternalServerError 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 **Response** ```json { "version": { "id": "3563baaa-07a2-46ed-9fd2-0e8a3c5f7ec2", "name": "Release 1.0", "createdAt": "2022-06-09T14:48:45.000Z", "updatedAt": "2022-06-09T19:50:49.000Z", "releaseNotes": "This is the first release.", "schemas": [ { "id": "13a441a3-6109-4f78-86eb-e0144d0ff275", "type": "openapi:3" } ], "collections": [ { "id": "aeedb353-494b-4424-82cf-358aece2bd1c", "name": "collection1" } ] } } ``` **SDK Code** ```python Successful Response import requests url = "https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2" headers = { "Accept": "application/vnd.api.v10+json", "x-api-key": "" } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Successful Response const url = 'https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2'; const options = { method: 'GET', headers: {Accept: 'application/vnd.api.v10+json', '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/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Accept", "application/vnd.api.v10+json") 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/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Accept"] = 'application/vnd.api.v10+json' 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/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2") .header("Accept", "application/vnd.api.v10+json") .header("x-api-key", "") .asString(); ``` ```php Successful Response request('GET', 'https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2', [ 'headers' => [ 'Accept' => 'application/vnd.api.v10+json', 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp Successful Response using RestSharp; var client = new RestClient("https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2"); var request = new RestRequest(Method.GET); request.AddHeader("Accept", "application/vnd.api.v10+json"); request.AddHeader("x-api-key", ""); IRestResponse response = client.Execute(request); ``` ```swift Successful Response import Foundation let headers = [ "Accept": "application/vnd.api.v10+json", "x-api-key": "" ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getpostman.com/apis/90ca9f5a-c4c4-11ed-afa1-0242ac120002/versions/12ece9e1-2abf-4edc-8e34-de66e74114d2")! 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() ```