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

Access and modify folder sharing permissions.

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

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

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

3 operations 3 paths 7 schemas 1 DELETE1 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 Folder 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 3

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

Folder 3

Access and modify folder sharing permissions.

GET
/folders/{fid}/acl
Get the Access Control List (ACL) for a folder to view permissions.
getFolderAcl 1 param → default
POST
/folders/{fid}/share
Share folder with an entity.
share 1 param body → default
DELETE
/folders/{fid}/share/{eid}
Remove permissions from the folder for the specified Access Control List (ACL) entry.
unShare 3 params → default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are BTAclEntryInfo (21 properties), BTAclInfo (13 properties), BTInheritedAclInfo (12 properties), BTShareParams (11 properties). Each schema is shown below with its type and property counts.

BTOwnerInfo
object
7 properties
BTAclInfo
object
13 properties
BTShareEntryParams
object
7 properties
BTUserState
string
BTInheritedAclInfo
object
12 properties
BTAclEntryInfo
object
21 properties
BTShareParams
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-folder-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 Folder 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.