Get Schema

GET

/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}

APISchema

This call fetches a single schema having the specified id.

Response contains a schema object with all the details related to the schema, namely, id, language, type, schema etc.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.getpostman.com/apis//versions//schemas/'

Response Example

{
  "schema": {
    "apiVersion": "ad810c39-df60-434e-a76f-a2192cd8d81f",
    "createdAt": "2019-02-12T19:34:49.000Z",
    "createdBy": "5665",
    "id": "e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822",
    "language": "yaml",
    "type": "openapi3",
    "updateBy": "5665",
    "updatedAt": "2019-02-12T19:34:49.000Z"
  }
}

Request

Path Params

apiId

string

required

apiVersionId

string

required

schemaId

string

required

Responses

🟢200Get schema

application/json

Body

schema

object

optional

apiVersion

string

optional

Example:

ad810c39-df60-434e-a76f-a2192cd8d81f

createdAt

string

optional

Example:

2019-02-12T19:34:49.000Z

createdBy

string

optional

Example:

5665

string

optional

Example:

e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822

language

string

optional

Example:

yaml

type

string

optional

Example:

openapi3

updateBy

string

optional

Example:

5665

updatedAt

string

optional

Example:

2019-02-12T19:34:49.000Z

Modified at 2023-08-15 05:41:03

Create Schema

Update Schema