Quickstart

Create an API keyCopy Anchor Link

In the Dashly dashboard, open Connectors → API & webhooks and fill in the key form:

• Key name: what the key is for, for example Zapier or Data warehouse sync.
• Scope: Read-only (the default) or Full access (read and write on every resource). Pick Full access if you want to follow step 4 below.
• Expiry: 30, 90 or 365 days, or no expiry.

Click Generate a key and copy the key straight away. It starts with ak_ and is shown only once.

export DASHLY_API_KEY="ak_…"

Check the key with GET /v1/meCopy Anchor Link

/v1/me tells you which agency the key belongs to, what it may do and how much of the monthly allowance is left. It reads no agency data, so it is the right first call for any integration.

curl https://api.usedashly.com/v1/me \
  -H "Authorization: Bearer $DASHLY_API_KEY"

{
  "data": {
    "agency": { "name": "Northwind Studio", "slug": "northwind-studio" },
    "scopes": ["*"],
    "quota": {
      "used": 1240,
      "limit": 50000,
      "remaining": 48760,
      "unlimited": false,
      "resetsAt": "2026-11-01"
    }
  }
}

A 401 with "code": "unauthorized" means the key is missing, mistyped, revoked or expired. See Authentication.

List your clientsCopy Anchor Link

Collections are paginated and come back in a { data, meta } envelope.

curl "https://api.usedashly.com/v1/clients?filter[status]=active&sort=-createdAt&per_page=20" \
  -H "Authorization: Bearer $DASHLY_API_KEY"

{
  "data": [
    {
      "id": "hsbftmp3f5",
      "name": "Boudbois",
      "slug": "boudbois",
      "sector": "Furniture",
      "website": "https://boudbois.fr",
      "linkedinUrl": null,
      "siren": null,
      "status": "active",
      "locale": null,
      "createdAt": "2026-09-14T08:21:37.000Z",
      "customFields": { "segment": "smb" }
    }
  ],
  "meta": { "page": 1, "perPage": 20, "total": 1, "totalPages": 1 }
}

Every id is a short public id like hsbftmp3f5. Use it everywhere: in paths and in relations such as clientId. Filters, sorting and search are covered in Requests and responses.

Create a recordCopy Anchor Link

With a Full access key (or one with the clients:write scope), create a client:

curl -X POST https://api.usedashly.com/v1/clients \
  -H "Authorization: Bearer $DASHLY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: create-client-northwind-0001" \
  -d '{
    "name": "Lumen Bakery",
    "status": "prospect",
    "website": "https://lumen-bakery.example"
  }'

The API answers 201 Created with the new record in data, including its public id. The Idempotency-Key header is optional. It makes the call safe to retry: see Idempotency.

If a value is refused, you get a 422 with "code": "validation_failed" and details on the field at fault. See Errors.