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 Task API

Create, access, and modify Tasks and Action Items.

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

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

This API exposes 5 operations across 3 paths, and defines 39 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 3 paths 39 schemas 2 GET3 POST

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 Task 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 3 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Task 5

Create, access, and modify Tasks and Action Items.

GET
/tasks
Lists tasks assigned to the specified user
getActionItems 8 params → default
POST
/tasks
Create a new task in a draft state.
createTask body → default
GET
/tasks/{tid}
Get a task by id.
getTask 1 param → default
POST
/tasks/{tid}
Update the task and its properties.
updateTask 1 param body → default
POST
/tasks/{tid}/{transition}
Execute a workflow transition.
transitionTask 2 params → default

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are BTCommentInfo (43 properties), BTTaskInfo (37 properties), BTWorkflowPropertyInfo (30 properties), BTTaskTeamSummaryInfo (26 properties). Each schema is shown below with its type and property counts.

BTCommentInfo
object
43 properties
BTCompanySummaryInfo
object
15 properties
BTThumbnailSizeInfo
object
7 properties
BTTaskItemInfo
object
22 properties
BTTaskTypeInfo
object
3 properties
CoordinatesInfo
object
3 properties
BTWorkflowableObjectInfo
object
15 properties
BTUserDetailSummaryInfo
object
BTTaskItemParams
object
References to add to the task.
12 properties
BTViewDataInfo
object
4 properties
BTUpdateTaskParams
object
7 properties
BTMetadataPropertyUiHintsInfo
object
1 property
BTTaskListResponse
object
5 properties
BTMetadataPropertyValidatorInfo
object
10 properties
BTPublishedWorkflowId
object
3 properties
BTMetadataPropertyInfo
object
24 properties
BTWorkflowStateInfo
object
9 properties
BTUserSummaryInfo
object
BTThumbnailInfo
object
4 properties
BTTaskUserSummaryInfo
object
24 properties
BTWorkflowableObjectObserver
object
24 properties
BTPublishedWorkflowInfo
object
Captures information about a published workflow
15 properties
BTWorkflowObserverState
string
BTBaseInfo
object
4 properties
BTPropertyValueParam
object
2 properties
BTWorkflowSnapshotInfo
object
14 properties
GlobalPermissionInfo
object
23 properties
BTUserBasicSummaryInfo
object
1 property 1 required
BTOwnerInfo
object
7 properties
BTMetadataEnumValueInfo
object
3 properties
BTTransitionType
string
Transition types(SUBMIT, APPROVE, REJECT)
BTWorkflowObserverEntryType
string
BTCommentAttachmentInfo
object
7 properties
BTWorkflowActionInfo
object
12 properties
BTCreateTaskParams
object
8 properties 1 required
BTWorkflowPropertyInfo
object
30 properties
BTTaskInfo
object
37 properties
BTTaskRbacRoleInfo
object
8 properties
BTTaskTeamSummaryInfo
object
26 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-task-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 Task 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.