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

Access user information.

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

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

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

4 operations 4 paths 28 schemas 3 GET1 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 User 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 4

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

User 4

Access user information.

POST
/users/session
Authenticate a user's Onshape credentials, and create a session.
session body → default
GET
/users/sessioninfo
Get the session information for an authenticated (signed-in) user.
sessionInfo → default
GET
/users/settings
Get the user settings for the signed-in user (i.e., you) for the current session.
getUserSettingsCurrentLoggedInUser 1 param → default
GET
/users/{uid}/settings
Get the user settings for any user in your organization (admins only).
getUserSettings 2 params → default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are BTUserSettingsInfo (44 properties), BTTeamSummaryInfo (25 properties), GlobalPermissionInfo (23 properties), BTWebClientCapabilitiesParams (22 properties). Each schema is shown below with its type and property counts.

BTWebRendererPerformanceMeasurementParams
object
4 properties
BTCompanySummaryInfo
object
15 properties
BTTeamSummaryInfo
object
25 properties
BTDocumentSelectorInfo
object
2 properties
BTMaterialLibrarySettingsInfo
object
2 properties
BTUserDetailSummaryInfo
object
BTLoginParams
object
11 properties
BTRole
string
BTCommonUnitsInfo
object
2 properties
BTDocumentSelectorParametersInfo
object
1 property 1 required
BTDefaultUnitInfo
object
Specifies which unit should be used for each supported quantity type.
2 properties
BTSelectItemViewStateInfo
object
3 properties
BTUserOAuth2SummaryInfo
object
BTIdentityInfo
object
7 properties
BTUserSummaryInfo
object
BTCommonUnitInfo
object
5 properties
BTBaseInfo
object
4 properties
BTUserSettingsInfo
object
44 properties
BTDefaultUnitsInfo
object
2 properties
BTMaterialLibraryMetadataInfo
object
8 properties
BTViewManipulationMouseKeyMappingInfo
object
6 properties
GlobalPermissionInfo
object
23 properties
BTUnitsMaximumDisplayPrecisionInfo
object
1 property
BTUserBasicSummaryInfo
object
1 property 1 required
BTOwnerInfo
object
7 properties
BTKeyMouseValuesInfo
object
2 properties
BTWebClientCapabilitiesParams
object
22 properties
BTSubstituteApproverInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-user-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 User 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.