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

Access information on how entities are structured within designs and documents.

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

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

This API exposes 1 operation across 1 path, and defines 11 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.

1 operations 1 paths 11 schemas 1 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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Onshape ProductStructure 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 1

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

ProductStructure 1

Access information on how entities are structured within designs and documents.

GET
/productstructure/whereused
Find where a part or assembly is used.
getWhereUsed 11 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are BTWhereUsedVersionReferencedInfo (11 properties), BTDocumentBaseSummaryInfo (8 properties), BTThumbnailSizeInfo (7 properties), BTWhereUsedItemInfoList (6 properties). Each schema is shown below with its type and property counts.

BTThumbnailInfo
object
4 properties
BTWhereUsedItemInfoList
object
6 properties
BTThumbnailSizeInfo
object
7 properties
BTUserBasicSummaryInfo
object
1 property 1 required
Property
object
Standard metadata properties of the item.
4 properties
BTBaseInfo
object
4 properties
ConfigInfo
object
The configuration parameters of the referring element.
6 properties
BTProductStructureItemInfo
object
Array of items in the current page.
1 property 1 required
BTDocumentBaseSummaryInfo
object
Summary information about the document containing the reference.
8 properties
BTMetadataValueInfo
object
Custom metadata properties of the item. Only populated when includeProperties is true.
3 properties 1 required
BTWhereUsedVersionReferencedInfo
object
List of document versions in which the queried item is referenced. Each entry contains the version info, referring document and element details, configuration,…
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-productstructure-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 ProductStructure 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.