API reference / Collectors
3 operations.
/api/v1/me/exportsZIP files with the collection, photos, scans, conversations and holds. One a day; while one is being made, that one is returned.
collector.requestAccountExport()exports:read(API keys are coming soon)X-Request-Idobject
unauthorized: Not signed in (no session or token, or an expired one).
export_rate_limited: One full export a day (details.nextAt says when the next is possible).
internal: Something went wrong on our side (quote the requestId).
not_available: Exports aren’t available on this deployment.
curl -X POST 'https://collection.id/api/v1/me/exports' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.requestAccountExport();/api/v1/me/exports/{id}Remove a finished export’s files now (they expire on their own too).
collector.deleteAccountExport()exports:read(API keys are coming soon)X-Request-Id| Name | In | Type | About |
|---|---|---|---|
idrequired | path | string (uuid) |
object
deletedbooleanrequiredunauthorized: Not signed in (no session or token, or an expired one).
not_found: Nothing at that address.
export_not_found: No such export of yours.
internal: Something went wrong on our side (quote the requestId).
curl -X DELETE 'https://collection.id/api/v1/me/exports/<id>' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.deleteAccountExport({ path: { id } });/api/v1/me/exports/{id}/downloadA signed link to one ZIP part of a ready export, valid for a few minutes.
collector.downloadAccountExport()exports:read(API keys are coming soon)X-Request-Id| Name | In | Type | About |
|---|---|---|---|
idrequired | path | string (uuid) | |
partoptional | query | integer | Which ZIP part (1 to parts).1–10000 · default 1 |
A short-lived link to one ZIP part of a ready export.
urlstring (uri)requiredA signed link to the ZIP part, valid for a few minutes.
fileNamestringrequiredpartintegerrequiredpartsintegerrequiredexpiresAtstring (date-time)requiredWhen the link stops working.
invalid_request: The query or body doesn’t match the schema (see errors[]).
unauthorized: Not signed in (no session or token, or an expired one).
not_found: Nothing at that address.
export_not_found: No such export of yours.
export_part_not_found: The export has no such part.
export_expired: The export isn’t ready, or its files expired.
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/me/exports/<id>/download' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.downloadAccountExport({ path: { id }, query: { … } });