latestOpenAPI 3.0.1Apache 2.02026-08-133021,2261.8 MB

aaa3e1322450

Document

Get a list of documents that meet the criteria you specify.

get/documents

Query parameters

qstring

Search for documents that contain the given string in the name. Search is not case-sensitive.

filterinteger

Type of documents to search: 0: My Documents | 1: Created | 2: Shared | 3: Trash | 4: Public | 5: Recent | 6: By Owner | 7: By Company | 9: By Team

ownerstring

Owner ID. Can be a user ID, company ID, or team ID, depending on ownerType.

ownerTypeinteger

Type of owner. 0: User | 1: Company | 2: Onshape. If the owner is a teamId, leave this unspecified.

sortColumnstring

Column by which to sort search results. name | modifiedAt | createdAt (default) | email | modifiedBy | promotedAt

sortOrderstring

Sort order. desc (descending, default), or asc (ascending).

labelstring

Label

projectstring

Project

parentIdstring

Parent Id

offsetinteger

Offset. Determines where search results begin. Default value is 0.

limitinteger

Maximum number of results to return per page. Default value is 20 (also the maximum). Number of results returned can be less than this value. Use the next URL in the response to fetch the next page.

Response

Success!