Skip to main content

Public API — getting started

The Dimmi Public API lets your organisation integrate HRIS systems, automation, and custom tools with Dimmi. It is organisation-scoped: every key only sees data for the organisation that owns it.

Base URL: https://api.dimmi.dk/api/v1
Interactive schema: OpenAPI reference (also available in-product at /api/v1/docs/ when signed into Dimmi).

What you can do​

  • Start cases (including relocation packages and cross-border journeys) with typed JSON create
  • List and retrieve cases, people, permits, certificates, and assignments
  • Download documents with short-lived URLs
  • Register webhooks for case, permit, certificate, and monitoring events

Quick path​

  1. In Dimmi, open Admin → Developers and create an API key with the scopes you need.
  2. Save the secret when it is shown — Dimmi displays it only once.
  3. Call the API with Authorization: Bearer <full_token> and, for writes, an Idempotency-Key header.
  4. Optionally register a webhook URL for events such as permit.granted.

Continue with Authentication, Scopes, Idempotency, and Webhooks.