Spreadsheets

Get a spreadsheet by Id

Get a spreadsheet by Id.

get/v1/drives/spreadsheets/{id}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/drives/spreadsheets/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Id of the spreadsheet

Query parameters

fieldsstring
Example:owners,directory,worksheets,usageSummary,tags,extension,domains,sourceHash,lifeCycle,votes,followers,mimeType,createdTime,modifiedTime

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The spreadsheet

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
serviceType'GoogleDrive' | 'SharePoint' | 'Sftp' | 'CustomDrive'
mimeType'application/vnd.google-apps.spreadsheet' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/vnd.ms-excel' | 'application/vnd.oasis.opendocument.spreadsheet' | 'text/csv' | 'text/tab-separated-values' | 'Other'
pathstring
driveFileIdstring
sizeinteger
fileVersionstring
createdTimeinteger
modifiedTimeinteger
sourceUrlstring
hrefstring uri
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
deletedboolean
sourceHashstring
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

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