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

Access company information.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

Authentication & Security 2

Onshape Company 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 9

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

Company 9

Access company information.

GET
/companies
Get all companies to which the specified user belongs.
findCompany 3 params → default
GET
/companies/{cid}
Get company information by company ID.
getCompany 1 param → default
GET
/companies/{cid}/documentsbyname
Get document by exact document name.
getDocumentsByName 2 params → default
POST
/companies/{cid}/globalpermission/{type}/{id}
Add one or more global permissions to company user or team.
addGlobalPermissionsForIdentity 3 params body → default
DELETE
/companies/{cid}/globalpermission/{type}/{id}
Remove global permissions for a company user or team.
clearGlobalPermissions 4 params → default
GET
/companies/{cid}/users
Get a list of members in a company.
getCompanyUsers 10 params → default
POST
/companies/{cid}/users
Add a user to a company.
addUserToCompany 1 param body → default
POST
/companies/{cid}/users/{uid}
Update the company's information for a user.
updateCompanyUser 2 params body → default
DELETE
/companies/{cid}/users/{uid}
Remove a user from a company, company teams, and all the direct shares.
removeUserFromCompany 4 params → default

Schemas 36

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

ProratedCharges
object
3 properties
BTThumbnailSizeInfo
object
7 properties
BTCompanySummaryInfo
object
15 properties
BTTeamSummaryInfo
object
25 properties
BTCompanyUserParams
object
7 properties
BTDiscountInfo
object
16 properties
BTUserDetailSummaryInfo
object
BTObjectState
string
BTAddressInfo
object
8 properties
BTCompanyUserInfo
object
16 properties
BTListResponseBTCompanyUserInfo
object
A list of resources that typically supports paging.
4 properties
BTCompanyInfo
object
17 properties
BTWorkspaceInfo
object
20 properties
BTVersionInfo
object
17 properties
BTIdentityInfo
object
7 properties
BTGlobalPermissionInfoItem
object
2 properties
BTUserSummaryInfo
object
BTThumbnailInfo
object
4 properties
BTBaseInfo
object
4 properties
BTGlobalTreeNodeInfo
object
23 properties 1 required
BTBillingPlanInfo
object
18 properties
UserRolePriority
string
BTCardInfo
object
6 properties
GlobalPermissionInfo
object
23 properties
BTOldPermission
string
BTListResponseBTCompanyInfo
object
A list of resources that typically supports paging.
4 properties
BTUserBasicSummaryInfo
object
1 property 1 required
BTOwnerInfo
object
7 properties
NextCharge
object
4 properties
BTPlanSubscriberInfo
object
9 properties
BTGlobalTreeNodeSummaryInfo
object
BTAPIApplicationSummaryInfo
object
8 properties
BTWorkspaceProtectionRuleOptions
string
BTPurchaseInfo
object
48 properties
BTDocumentLabelInfo
object
BTGlobalPermissionInfo
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onshape-company-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 Document API
AE Profile APIs.io
Onshape Drawing API
AE Profile APIs.io
Onshape Element API
AE Profile APIs.io
#Company
← Back to O APIs
API Details
ID
onshape:onshape-company-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-company-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onshape-company-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 Company 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.