Skip to main content
The DMLY REST API gives you programmatic access to everything your workspace holds: the CRM, the unified inbox, broadcasts and automations, appointments and classes, the commercial catalogue, finance, and media.

​
Base URL

All endpoints live under a single version prefix:
If you are on a whitelabel or agency domain, use your own host in place of dash.dmly.io. The path is always /api/v1.

​
How it works

Authentication

One workspace API key authenticates you and selects the workspace.

Pagination

Lists return data, links and meta.

Errors

Conventional status codes and a consistent error body.

Rate limits

60 requests per minute, per IP address.

​
Conventions

  • Identifiers are UUIDs. Every resource is addressed by its public uuid, which the API returns as id. Internal database ids are never exposed.
  • No workspace in the URL. Your API key already determines the workspace, so paths look like /contacts/{contact} rather than /workspaces/{id}/contacts/{contact}.
  • Single resources return { "data": { … } }.
  • JSON in, JSON out. Send Content-Type: application/json on writes. The only exception is uploading media (POST /media), which takes multipart/form-data.

​
Events

Rather than polling, subscribe to any of the 73 webhook topics and DMLY will post to your endpoint as things happen — a message arrives, an invoice is paid, an appointment is booked.

​
Try it

Every endpoint page has a playground. Paste a workspace API key into the Authorization panel and you can call your real workspace straight from these docs.
The playground calls the live API against real data. Create a test workspace before experimenting with anything destructive.