Start an export
POST/objects/:object_id/exports
Export records to an XLSX file in the background. Send either a shared view_id
(or all), or filters + sort + columns by field api_id; search narrows
by the primary field. Linked records export their names, lookups their stored
values. Poll GET …/exports/{job_id} until status is completed, then fetch
download_url (valid for 30 minutes).
Request
Responses
- 202
- 400
- 401
- 403
- 404
Export started.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.