Item

Get all items owned by a company/classroom/enterprise.

Returns a list of all items owned by the company/classroom/enterprise.

Either documentId or companyId must be provided.

get/items

Request

  • Base URL: https://cad.onshape.com/api/v17
  • URL: https://cad.onshape.com/api/v17/items
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token, scopes: OAuth2Read) and HTTP basic

Query parameters

documentIdstring

ID of any document owned by the company/classroom/enterprise.

companyIdstring

Company/classroom/enterprise ID.

qstring

Optional search string.

publishStatesstring

Refine returned items by publish states: 0: PENDING | 1: ACTIVE | 2: INACTIVE

classificationstring

Refine returned items by classification. Classifications are managed in company/classroom/enterprise Properties settings.

offsetinteger

Number of entries to skip in the returned list.

limitinteger

The number of list entries to return in a single API call.

Response

default response

Changes

No recorded changes to this operation across all 1 revision of this API.