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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Onshape

Onshape Workflow API

Access and modify workflows.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 5 operations across 5 paths, and defines 25 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.

5 operations 5 paths 25 schemas 5 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
Contact
api-support@onshape.zendesk.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Onshape Workflow 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 5

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

Workflow 5

Access and modify workflows.

GET
/workflow/active
Get all active workflows for the currently logged in user's company.
getActiveWorkflow 1 param → default
GET
/workflow/c/{companyId}/approvers
Get all identities allowed to be approvers on a workflow object.
getAllowedApprovers 5 params → default
GET
/workflow/companies/{cid}/objects
Enumerate all of a company's workflowable objects.
enumerateObjectWorkflows 5 params → default
GET
/workflow/obj/{objectId}
Lightweight information about the current state of a workflowable object like release package.
getWorkflowById 3 params → default
GET
/workflow/obj/{objectId}/auditlog
Get all audit log entries for a workflowable object.
getAuditLog 1 param → default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are BTActiveWorkflowInfo (41 properties), BTTeamSummaryInfo (25 properties), GlobalPermissionInfo (23 properties), BTWorkflowAuditLogEntryInfo (18 properties). Each schema is shown below with its type and property counts.

BTMetadataStateType
string
The current state metadata values if applicable.
BTWorkflowAuditLogEntryInfo
object
18 properties
BTActiveWorkflowInfo
object
41 properties
BTCompanySummaryInfo
object
15 properties
BTActiveWorkflowTypeInfo
object
3 properties
BTTeamSummaryInfo
object
25 properties
BTWorkflowAuditLogInfo
object
6 properties
BTUserDetailSummaryInfo
object
BTListResponseBTWorkflowObserverOptionInfo
object
A list of resources that typically supports paging.
4 properties
BTListResponseBTObjectWorkflowInfo
object
A list of resources that typically supports paging.
4 properties
BTPublishedWorkflowId
object
3 properties
BTIdentityInfo
object
7 properties
BTUserSummaryInfo
object
BTWorkflowObserverOptionInfo
object
Array of items in the current page.
9 properties
BTPublishedWorkflowInfo
object
Captures information about a published workflow
15 properties
BTPropertyUpdateInfo
object
5 properties
BTBaseInfo
object
4 properties
BTAliasInfo
object
9 properties
GlobalPermissionInfo
object
23 properties
BTRbacRoleInfo
object
7 properties
BTUserBasicSummaryInfo
object
1 property 1 required
BTOwnerInfo
object
7 properties
BTAliasEntryInfo
object
6 properties
BTAPIWorkflowableType
string
All workflowable types that can be enumerated.
BTObjectWorkflowInfo
object
An workflowable object like Release or Task that supports states and transitions.
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-workflow-api-openapi.yml Raw ↑

Other APIs Onshape publishes across the network.

Onshape Account API
AE Profile APIs.io
Onshape Alias API
AE Profile APIs.io
Onshape APIApplication API
AE Profile APIs.io
Onshape AppAssociativeData API
AE Profile APIs.io
Onshape AppElement API
AE Profile APIs.io
Onshape Assembly API
AE Profile APIs.io
Onshape Billing API
AE Profile APIs.io
Onshape BlobElement API
AE Profile APIs.io
Onshape Comment API
AE Profile APIs.io
Onshape Company API
AE Profile APIs.io
Onshape Document API
AE Profile APIs.io
Onshape Drawing API
AE Profile APIs.io
#Workflows
← Back to O APIs
API Details
ID
onshape:onshape-workflow-api
Base URL
https://cad.onshape.com/api/v16
Docs
https://onshape-public.github.io/docs/
Provider
Onshape
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=onshape-workflow-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onshape-workflow-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Onshape Workflow 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.