Skip to main content

Integration Specifications

Prerequisites

How to obtain the API key and API secret key

  1. Log in to Onshape and open company settings. Select Developer in the left menu, then click Create new API key on the API keys tab. The Onshape company settings with the API keys tab under Developer and the Create new API key button
  2. On the Create new API key screen, enter the required Name and User. Under Permissions, select the following four items, then click Create API key.
    • Application can read your profile information
    • Application can read your documents
    • Application can write to your documents
    • Application can delete your documents and workspaces
    The Onshape Create new API key screen with four Permissions items selected
  3. After you create the key, the access key and secret key appear. Copy them and save them.

How to obtain the workspace key (Company ID)

  1. Select Details in the left menu. Click Copy to clipboard next to Company ID to copy it, and save it. The Onshape Details page with the Company ID and the Copy to clipboard button

Setting up the integration

  1. In the integration screen, search for Onshape.
  2. Enter the access key in API Key, the secret key in API Secret Key, and the Company ID in Workspace key. Then click Integrate. The Onshape integration screen with the API key, API secret key, and workspace key fields
  3. When the integration with Onshape succeeds, registered user information appears in the account list. If it does not complete successfully, first try the steps in Troubleshoot SaaS integration errors. If the issue persists, check Information to provide and contact Support.
Last modified on October 7, 2026