How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Onshape OpenApi API

Get the OpenAPI specification for the Onshape API.

Onshape OpenApi API is one of 42 APIs that Onshape publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OpenAPI. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 2 operations across 2 paths, and defines 34 schemas. It is described by OpenAPI 3.0.1, at version 1.218.84032-34acba44be17.

Requests are made against a single base URL, https://cad.onshape.com/api/v16.

2 operations 2 paths 34 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.218.84032-34acba44be17
Base URL
https://cad.onshape.com/api/v16
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Onshape OpenApi API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 24 scopes. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • OAuth2 — Use OAuth 2.0 to authenticate requests.
  • BasicAuth — Use Basic Authentication with API Keys (key as username and secret as password) to authenticate requests.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

OpenApi 2

Get the OpenAPI specification for the Onshape API.

GET
/openapi
Get the OpenAPI specification for the Onshape REST API.
getOpenApi 11 params → default
GET
/openapi/tags
Get the list of tags in the Onshape OpenAPI specification.
getTags → default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Schema (67 properties), SchemaObject (64 properties), Parameter (15 properties), PathItem (14 properties). Each schema is shown below with its type and property counts.

OAuthFlow
object
5 properties
Components
object
11 properties
Server
object
4 properties
Tag
object
4 properties
PathItem
object
14 properties
Discriminator
object
3 properties
Link
object
9 properties
XML
object
6 properties
RequestBody
object
5 properties
ExternalDocumentation
object
3 properties
OpenAPI
object
11 properties
Type
string
In
string
Parameter
object
15 properties
ApiResponse
object
6 properties
Header
object
10 properties
Operation
object
13 properties
VersionAlias
string
Callback
object
3 properties
Example
object
7 properties
SchemaObject
object
64 properties
ServerVariable
object
4 properties
Encoding
object
6 properties
License
object
4 properties
SecurityScheme
object
10 properties
Info
object
8 properties
Schema
object
67 properties
StyleEnum
string
MediaType
object
6 properties
SecurityRequirement
object
1 property
Contact
object
4 properties
OAuthFlows
object
5 properties
Status
string
BTRestUserRole
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-openapi-api-openapi.yml Raw ↑

Other APIs Onshape publishes across the network.

Onshape Account API
Onshape Alias API
Onshape APIApplication API
Onshape AppAssociativeData API
Onshape AppElement API
Onshape Assembly API
Onshape Billing API
Onshape BlobElement API
Onshape Comment API
Onshape Company API
Onshape Document API
Onshape Drawing API
Where this information came from

This is an independent, third-party profile of Onshape OpenApi API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.