Developers · API endpoints

Export

Export all your data as JSON, or as a ZIP archive with JSON-LD, documents and a SHA-256 manifest.

Version
v1.0.0
Base URL
https://dppapi-production.up.railway.app/v1
Format
JSON · OpenAPI 3.1
FeedbackLast updated

Everything you hold with us, in forms that need nothing from us to read. Exports stay available to a frozen organisation, because leaving must always be possible. See the data portability guide.

Personalise the samples. Paste a test key and every snippet uses it — and your own model and passport ids.

GET/v1/export
read scope

Export all data (JSON)

One JSON document: organisation, plants, and every model with its documents (metadata), components, conformity, declarations, batteries, registrations, passports and events.

Responses

  • 200OK — The export (abridged).

Errors1

GET /v1/export
curl "https://dppapi-production.up.railway.app/v1/export" \-H "Authorization: Bearer $DPP_API_KEY"
200 OK · The export (abridged).
{"exportedAt": "2027-06-30T12:00:00.000Z","format": "collecta-dpp-export/1","organisation": { "id": "cm1q7v0aa0000l70f1a2b3c4d", "legalName": "Example Batteries GmbH" },"plants": [],"models": []}
GET/v1/export/archive
read scope

Export archive (ZIP)

A ZIP streamed as it is built: export.json, one JSON-LD file per published passport, the document files, QR and label artwork, supplier uploads, mapping templates, audit.jsonl, a README and manifest.json with the size and SHA-256 of every entry.

Responses

  • 200OK — application/zip, Content-Disposition: attachment; filename="collecta-dpp-export-<date>.zip".

Errors1

GET /v1/export/archive
curl "https://dppapi-production.up.railway.app/v1/export/archive" \-H "Authorization: Bearer $DPP_API_KEY"
200application/zip, Content-Disposition: attachment; filename="collecta-dpp-export-<date>.zip".

Cookie preferences

You choose which cookies are used. You can change your choice at any time with “Cookie settings” in the footer. Privacy policy

Necessary

Always on

Needed for the site to work: your light/dark theme and this cookie choice are stored in your browser. They do not track you.

Analytics

Google Analytics 4 measures how pages are used through statistics, which helps us improve the site. If you accept, it sets cookies and measures your visit in full. If you decline, it sets no cookies, but Google may still receive technical data such as the page viewed, your browser type and IP address.

_ga, _ga_* · up to 2 years · Google