---
title: "Get the OpenAPI specification for the Onshape REST API."
method: GET
path: "/openapi"
tags: ["OpenApi"]
---

# Get the OpenAPI specification for the Onshape REST API.

`GET /openapi`

The Onshape API OpenAPI specification is returned in the JSON format.

## Query parameters

- `version` string
- `versionAlias` 'LAST_MINOR' | 'LAST_BUILD'
- `noFilter` boolean
- `includedTags` string[]
- `excludedTags` string[]
- `includeDeprecated` boolean
- `onlyDeprecated` boolean
- `documentationStatuses` Status[]
- `restUserRole` 'PUBLIC' | 'INTERNAL'
- `operationIds` string[]
- `excludedOperationIds` string[]

## Response `default`

default response

---

[API](https://skmtc.net/onshape/apis/onshape-rest-api.md) · [All operations](https://skmtc.net/onshape/apis/onshape-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onshape/onshape-rest-api/revisions/aaa3e1322450/schema)