Get an export
Retrieve one export, to follow it until its file is ready.
An export moves on its own, in the background, while its status is preparing. Ask again to follow it. An email says when it is ready.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Path parameters
Sent as JSON. Anything not listed here is ignored.
The id of the export. One belonging to another account answers 404.
Returns
An export object. One of another account answers 404.
The export.
Always account_export. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
Where the export stands: preparing, ready, failed or expired. The file is prepared in the background, and an email says when it is ready.
The vaults the file holds.
The id of one of those vaults. A vault deleted since the export was asked for is left out.
The size of the file in bytes, or null until it is ready.
When the file was complete, as a count of seconds since 1970, or null until it is ready.
When the file is deleted, seven days after it was ready unless a newer export of the account is ready first, as a count of seconds since 1970, or null until it is ready. From that moment it can no longer be downloaded.
When the export was asked for, as a count of seconds since 1970.
Where to find this record.
The absolute address this record is read from.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.