/
ON
onshape
/
Onshape REST API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 8h ago · Updated 1w ago
latest
OpenAPI 3.0.1
Apache 2.0
2026-08-13
302
1,226
1.8 MB
aaa3e1322450
Account
4
get
Get a list of all app purchases made for the specified plan.
get
Get a list of all app purchases made by the current user.
post
Mark a purchase as consumed by the current user.
delete
Cancel a recurring subscription for the specified account ID and purchase ID.
Alias
6
get
Get a list of all aliases that exist for your enterprise.
post
Create an alias in your enterprise.
get
Get an alias by ID.
post
Add, remove, replace, or rename entries in an alias list.
delete
Delete an alias from your enterprise.
get
Get all users and teams assigned to an alias.
APIApplication
7
get
Get company-level preference settings for an application.
post
Update company preference settings for an application.
delete
Delete a company's application preference settings.
get
Get user-level preference settings for an application.
post
Update a user's application preference settings.
delete
Delete a user's application preference settings.
get
Get a list of the client extensions the specified user has granted/accepted terms for.
AppAssociativeData
4
post
Copy associative data from one view to another.
get
Get the associative data for the specified app element.
post
Set the associative data for the specified app element.
delete
Delete the associative data from the specified app element.
AppElement
27
post
Create a new application element.
post
Create multiple empty application elements at once.
get
Download the blob element (i.e., a file) stored in an app element in a document's workspace.
post
Create a new blob subelement from an uploaded file.
delete
Delete a blob subelement from an app element.
get
Get a list of all transactions performed on an element.
post
Start a transaction
delete
Abort a transaction.
post
Merge multiple transactions into one microversion.
get
Download a blob subelement from the specified app element.
get
Get a list of all blob subelement IDs for the specified workspace, version, or microversion.
get
Compare app element JSON trees between workspaces/versions/microversions in a document.
get
Get a list of all subelement IDs in a specified workspace/version/microversion.
post
Update the content for the specified app element.
get
Get the history of the specified all element.
get
Get a list of all subelement IDs in a specified workspace/version/microversion.
get
Get the full JSON tree for the specified workspace/version/microversion.
post
Get the JSON at specified paths for an element.
get
Get a list of multiple subelements by document ID, workspace or version or microversion ID, tab ID, and subelement IDs.
delete
Delete multiple subelements array by document ID, workspace or version or microversion ID, tab ID, and subelement IDs.
delete
Deletes the content from the specified app element.
post
Creates a reference to an app element.
get
Resolves a single reference to an app element.
post
Update an app element reference.
delete
Delete an app element reference.
get
Resolves bulk app element references.
get
Resolves bulk app element references.
Assembly
27
get
Get the view data for all named views for the specified element.
post
Create a new assembly tab in the document.
post
Gets the Bill Of Materials (BOM) for the specified assembly, or creates a BOM if none exist.
post
Update an existing feature for an Assembly.
delete
Delete a feature from an assembly.
delete
Delete an instance of an assembly.
post
Insert an instance of a part, sketch, assembly, or Part Studio into an assembly.
post
Update mate values for the given mates in the specified assembly.
post
Modify an assembly.
post
Transform a list of assembly occurrences.
post
Create new instances with transformation.
get
Get definition information for the specified assembly.
get
Get the Bill Of Materials (BOM) content for the specified assembly.
get
Get bounding box information for the specified assembly.
get
Get a list of display states for the specified assembly.
get
Get a list of exploded views for the specified assembly.
get
Get the definitions of the specified features in an assembly.
post
Add a feature to the assembly feature list.
get
Get the feature spec definitions for an assembly.
get
Get the mass properties for the assembly.
get
Get a list of all named positions for the assembly.
get
Get an array of shaded view images for the document.
post
Export the assembly to glTF.
post
Export the assembly to OBJ.
post
Export the assembly to STEP.
get
Get a list of mate values in the specified assembly.
post
Export the assembly to another format.
Billing
1
get
Get all billing plans and their information for an application by client ID.
BlobElement
5
post
Upload a file and create a blob element from it.
get
Download a file from a blob element for the specified workspace/version/microversion.
post
Update a blob element by uploading a file.
post
Change the measurement units for the blob element.
post
Export a blob element to another format.
Comment
10
get
Get a list of comments in a document.
post
Update a document with a new comment.
get
Get details for a comment.
post
Update the content of an existing comment.
delete
Delete a comment from a document.
post
Add an attachment to a comment.
delete
Delete all attachments from a comment.
get
Get the attachment with the specified file extension that is associated with the specified comment.
post
Reopen a resolved comment.
post
Resolve a comment.
Company
9
get
Get all companies to which the specified user belongs.
get
Get company information by company ID.
get
Get document by exact document name.
post
Add one or more global permissions to company user or team.
delete
Remove global permissions for a company user or team.
get
Get a list of members in a company.
post
Add a user to a company.
post
Update the company's information for a user.
delete
Remove a user from a company, company teams, and all the direct shares.
Document
37
get
Get a list of documents that meet the criteria you specify.
post
Create and upload a document.
get
Download external data file(s) associated with the document.
get
Retrieve versions by document ID.
post
Create version by document ID.
get
Retrieve version by document ID and version ID.
post
Update external references to latest by document ID, workspace ID, and tab ID.
post
Move tab by document ID and workspace ID.
post
/documents/d/{did}/w/{wid}/revertunchangedtorevisions
post
/documents/d/{did}/w/{wid}/syncAppElements
get
Retrieve workspaces by document ID.
post
Create workspace by document ID.
delete
Delete workspace by document ID and workspace ID.
get
Retrieve document history by document ID and workspace or microversion ID.
get
Retrieve tabs and folders by document ID and workspace or version or microversion ID.
get
Retrieve tabs by document ID and workspace or version or microversion ID.
get
Get the selected units and precision by document ID and workspace or version or microversion ID.
get
Retrieve current microversion by document ID and workspace or version ID.
post
Export document by document ID, workspace or version ID, and tab ID.
get
Retrieve insertables by document ID and workspace or version ID.
post
Search document.
get
Retrieve document by document ID.
post
Update document attributes by document ID.
delete
Delete document by document ID.
get
Retrieve access control list by document ID.
post
Allow or deny anonymous access to a document or publication.
post
Make a document public or private.
post
Update document notes by document ID.
get
Retrieve Document permissions by document ID.
post
Share document by document ID.
delete
Remove document View permissions from a user or other entity.
post
Share document by document ID with Onshape support.
delete
Unshare document with support.
get
Merge preview of changes that will occur based on document ID, workspace ID and source workspace/version ID
post
Restore version or microversion to workspace by document ID, workspace ID, and version or microversion ID.
post
Copy workspace by document ID and workspace ID.
post
Merge into workspace by document ID and workspace ID.
Drawing
7
post
Create a new drawing in a document.
post
Modify a drawing via JSON payload.
get
Get a list of all valid formats the drawing can be translated (exported) to.
get
Get details of all drawing views.
get
Get view geometry of a drawing view in JSON format.
post
Translate (export) a drawing to a different format.
get
Get the status of a drawing modification operation.
Element
8
post
Copy an element from a source document.
post
Encode a configuration option for use in other API calls.
delete
Delete an element from a document.
post
Update or replace references in an element.
get
Get the configuration definition for a Part Studio, Variable Studio, or Assembly.
post
Update the configuration definition for a Part Studio, Variable Studio, or Assembly.
get
Decode a configuration string.
get
Gets the list of formats an element can be translated to or from.
ExportRule
1
get
Get a list of valid export rule options for the user or company.
FeatureStudio
4
post
Create a new Feature Studio tab in a document.
get
Get the text for a Feature Studio element.
post
Update the text for a Feature Studio element.
get
Get the feature specs for a Feature Studio element.
Folder
3
get
Get the Access Control List (ACL) for a folder to view permissions.
post
Share folder with an entity.
delete
Remove permissions from the folder for the specified Access Control List (ACL) entry.
Insertable
1
get
Get a list of things in this document that can be inserted elsewhere.
Item
5
get
Get all items owned by a company/classroom/enterprise.
post
Create a new item.
get
Get item by ID.
post
Update an item.
delete
Delete an item.
Material
2
post
Updates an existing material library
get
Get a list of materials from a material library.
Metadata
11
get
Get the metadata for all elements in a document.
get
Get the metadata for an element.
post
Update the metadata for an element.
get
Get the metadata for an assembly, including supporting metadata.
get
Get the metadata for all parts in a document.
get
Get the metadata for a part.
post
Update the metadata for a part.
get
Get the metadata for a workspace or version.
post
Update the metadata for a workspace or version.
post
Update the metadata for a standard content part.
get
Get the metadata for a standard content part.
MetadataCategory
1
get
Get properties associated with the specified metadata categories.
NumberingScheme
1
post
Get the next available part number for a release item.
OpenApi
2
get
Get the OpenAPI specification for the Onshape REST API.
get
Get the list of tags in the Onshape OpenAPI specification.
Part
12
get
Get all parts in a workspace, version, or microversion.
get
Get all parts in an element.
get
Get a part's body details.
get
Get a part's bounding box details.
get
Synchronously export a part to a glTF file.
get
Get a part's mass properties.
get
Synchronously export a part to a Parasolid file.
get
Get a part's shaded views.
get
Get a part's sheet metal bend table.
get
Synchronously export a part to an STL file.
get
Get a list of a part's tessellation edges.
get
Get a list of a part's tessellation faces.
PartNumber
1
post
/partnumber/nextnumbers
PartStudio
27
get
Get a list of all named views that exist in the Part Studio.
post
Create a new Part Studio in a document.
post
Update the definition of a Part Studio feature.
delete
Delete a Part Studio feature.
post
Move the Feature List rollback bar in the Part Studio.
post
Update multiple features in a Part Studio
get
Get the body details for a Part Studio.
get
Get the bounding boxes for a Part Studio.
get
Get the differences between two Part Studios in a single document.
get
Get a list of features instantiated in the Part Studio.
post
Add a feature to the Part Studio's Feature List.
post
Evaluate the FeatureScript snippet for a Part Studio.
get
Get the FeatureScript representation of a Part Studio.
get
Get the specs for a Part Studio feature.
get
Compute and return a FeatureScript table for a Part Studio.
get
Synchronously export a Part Studio to a glTF file.
post
Find corresponding deterministic IDs from a source document microversion at the target version.
get
Get the mass properties for a Part Studio.
get
Synchronously export a Part Studio to a Parasolid file.
get
Get a list of shaded views for a Part Studio.
get
Synchronously export a Part Studio to an STL file.
get
Get a list of all edges in a Part Studio.
get
Get a list of all faces in a Part Studio.
post
Asynchronously export a Part Studio to glTF.
post
Asynchronously export a Part Studio to OBJ.
post
Asynchronously export a Part Studio to STEP.
post
Asynchronously export a Part Studio to another format.
ProductStructure
1
get
Find where a part or assembly is used.
PropertiesTableTemplate
5
post
Create a new properties table template.
get
Get all properties table templates available for a company.
get
Get all table templates that are available to use on the provided document.
get
Get a properties table template by template ID.
delete
Delete a properties table template.
Publication
7
post
Create a new publication.
post
Update publication's attributes name, description, and notes.
delete
Delete a publication.
post
Add an item in a publication.
delete
Remove an item from a publication.
get
Get all items in a publication.
post
Add publication items in bulk.
ReleasePackage
4
post
Create an obsoletion candidate to make an existing revision obsolete.
post
Create a new release candidate for one or more items.
get
Get details about the specified release candidate.
post
Update the release/obsoletion candidate/item properties.
Revision
9
get
Get details for the specified revision.
get
Get all revisions for a company.
get
Get all revisions for an element (tab).
get
Get all revisions for a part ID.
get
Get all revisions for a part number.
delete
Delete all revisions for a part number.
get
Get all revisions for a document.
get
Get all revisions for a version.
get
Get the latest revision information for a part.
Sketch
3
get
Get information for all sketches in Part Studio.
get
Get all bounding boxes for a sketch.
get
Get the tessellations of a sketch in a Part Studio.
StandardContent
3
post
Sets the part number and description for a standard content component.
get
Gets all possible values for each of the standard content parameters.
get
List all standard content.
Task
5
get
Lists tasks assigned to the specified user
post
Create a new task in a draft state.
get
Get a task by id.
post
Update the task and its properties.
post
Execute a workflow transition.
Team
3
get
Get a list of all teams the current user belongs to.
get
Get team information by team ID.
get
Get a list of a team's members.
Thumbnail
11
get
Get the thumbnail info for a document in the default workspace.
get
Get the thumbnail info for a version of a document.
get
Get the thumbnail info for a workspace.
get
Get the thumbnail image with the given configuration for an element.
get
Get the thumbnail image with the given size for a document.
get
Get the thumbnail info structure for an element.
post
Set the thumbnail image for an application element.
delete
Delete an element's thumbnail.
get
Get the thumbnail image with the given size for an element.
get
This endpoint will be deprecated soon. Use `getThumbnailForDocument` instead.
get
This endpoint will be deprecated soon. Use `getThumbnailForDocumentAndVersion` instead.
Translation
5
get
Get information on an in-progress or completed translation by document ID.
post
Import or upload a CAD file into Onshape, and translate the data into parts or assemblies.
get
Get a list of formats this translation can use.
get
Get information on an in-progress or completed translation by translation ID.
delete
Delete a translation request.
User
4
post
Authenticate a user's Onshape credentials, and create a session.
get
Get the session information for an authenticated (signed-in) user.
get
Get the user settings for the signed-in user (i.e., you) for the current session.
get
Get the user settings for any user in your organization (admins only).
Variables
7
post
Assign variables to a Variable Studio
post
Set the Variable Studio references for an element.
post
Set the scope the Variable Studio.
post
Create a new Variable Studio in a document and workspace.
get
Get the contents of all variable tables in an element.
get
Get the Variable Studio references for an element.
get
Get the scope of a Variable Studio.
Version
1
get
Get all versions of the Onshape REST APIs.
Webhook
6
get
Get a list of all webhooks registered by a user or company.
post
Create a new webhook.
get
Get webhook info by webhook ID.
post
Update a webhook.
delete
Unregister a webhook.
post
Ping a webhook.
Workflow
5
get
Get all active workflows for the currently logged in user's company.
get
Get all identities allowed to be approvers on a workflow object.
get
Enumerate all of a company's workflowable objects.
get
Lightweight information about the current state of a workflowable object like release package.
get
Get all audit log entries for a workflowable object.
Account
Get a list of all app purchases made for the specified plan.
get
/accounts/plans/{planId}/purchases
Path parameters
planId
string
required
Query parameters
offset
integer
limit
integer
Response
default response