client.exportsOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/exportsexports.create
Creates a credential-owned asynchronous CSV export in the owning cell. Resource permissions, sharing filters and a 10,000-row bound are applied again by the export worker.
client.exports.create(data: ExportCreate, options: MutationOptions = {})- Return form
Promise- Operation ID
createExport- Required scopes
exports:write- Conditional scopes
contacts:readprojects:readtasks:readtime-entries:read- SDK parameters
data: ExportCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
ExportCreateapplication/json- Success
201 ExportCreation envelope
/exports/{id}exports.get
Returns only credential-owned job status; storage coordinates and signed URLs remain private.
client.exports.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getExport- Required scopes
exports:read- Conditional scopes
contacts:readprojects:readtasks:readtime-entries:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 Export envelope
/exports/{id}/download-intentexports.createDownloadIntent
Creates a short-lived single-export capability only after the job succeeded and credential ownership, workspace and resource-domain permissions are revalidated.
client.exports.createDownloadIntent(id: string, options: RequestOptions = {})- Return form
Promise- Operation ID
createExportDownloadIntent- Required scopes
exports:read- Conditional scopes
contacts:readprojects:readtasks:readtime-entries:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
201 ExportDownloadIntent envelope
/exports/{id}/downloadexports.download
Consumes the header-only opaque intent, resolves a private cell-local storage target internally, rejects redirects and streams at most 50 MiB. The storage URL never appears in the public response.
client.exports.download(id: string, options: ExportDownloadOptions)- Return form
Promise- Operation ID
downloadExport- Required scopes
exports:read- Conditional scopes
contacts:readprojects:readtasks:readtime-entries:read- SDK parameters
id: stringoptions: ExportDownloadOptions- Path request fields
id: string- Header request fields
X-TeamGrid-Export-Download-Intent: string- Success
200 string
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
exports.downloadStream
SDK convenience helper without a one-to-one public API operation.
client.exports.downloadStream(id: string, options: ExportDownloadOptions)PromiseErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.