latestOpenAPI 3.0.1Apache 2.02026-08-133021,2261.8 MB

aaa3e1322450

Account4

Alias6

APIApplication7

AppAssociativeData4

AppElement27

Assembly27

Billing1

BlobElement5

Comment10

Company9

Document37

Drawing7

Element8

ExportRule1

FeatureStudio4

Folder3

Insertable1

Item5

Material2

Metadata11

MetadataCategory1

NumberingScheme1

OpenApi2

Part12

PartNumber1

PartStudio27

ProductStructure1

PropertiesTableTemplate5

Publication7

ReleasePackage4

Revision9

Sketch3

StandardContent3

Task5

Team3

Thumbnail11

Translation5

User4

Variables7

Version1

Webhook6

Workflow5

OpenApi

Get the OpenAPI specification for the Onshape REST API.

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

get/openapi

Query parameters

versionstring

Specify a version of Onshape from which the OpenAPI is generated. If '*' is specified in any of the version fields, that indicates any version if acceptable.

versionAlias'LAST_MINOR' | 'LAST_BUILD'

Version aliases based on the currently released version.

noFilterboolean

Do not filter the specification at all.

includedTagsstring[]

Return only operations with tags included in includedTags.

excludedTagsstring[]

If an operation contains an excluded tag, it is not returned from this endpoint.

includeDeprecatedboolean

Include deprecated endpoints.

onlyDeprecatedboolean

Only include deprecated endpoints.

documentationStatusesStatus[]

Only return endpoints that have the specified documentation status. Default is to return all the endpoints the user should have access to.

restUserRole'PUBLIC' | 'INTERNAL'

The REST user role for which this spec is requested.

operationIdsstring[]

Only return operations with specified ids.

excludedOperationIdsstring[]

Do not return operations with specified ids.

Response

default response