Skip to navigation

Get Worksheet by ID

Beta
Get a single Worksheet by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

worksheet_idstringRequired
ID of the Worksheet.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Query parameters

returninglist of stringsOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitlist of stringsOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK
__typenamestringOptional
applicableReviewProcessesstringOptionalformat: "uri"
archiveReasonstring or nullOptional
archivedbooleanOptional
authorsstring or nullOptionalformat: "uri"
createdAtstringOptionalformat: "datetime"
creatorobjectOptional
folderobjectOptional
idstringOptional
modifiedAtstringOptionalformat: "datetime"
namestringOptional
reviewobject or nullOptional
reviewSourceobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error