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

What you can do​

  • Start cases with typed JSON create, including short-term visitors via POST /cases/short-term
  • List and retrieve cases and people
  • On each person, read nested permits, certificates, and cases (enough to reconstruct cross-border journeys without a separate assignments API)
  • List and download documents with short-lived URLs
  • Receive webhooks for case, permit, certificate, and monitoring events (configured in the portal — see below)

What you configure in the portal​

In Dimmi, open Admin → Developers to:

  1. Create an API key with the scopes you need
  2. Register webhook URLs and event subscriptions

Webhook CRUD is not available via the API key. Your integration only needs to receive and verify deliveries — see Webhooks.

Quick path​

  1. Create an API key in Admin → Developers and save the secret (shown once).
  2. Call the API with Authorization: Bearer <full_token> and, for writes, an Idempotency-Key header.
  3. Optionally register a webhook URL for events such as permit.granted.
  4. Read people with GET /people/{id} for permits and certificates; use GET /cases?person_id= for the full case list for a person.

Continue with Authentication, Scopes, Idempotency, and Webhooks.