OpenAPI
Download the OpenAPI 3.1 contract of the Dashly API and use it with Postman, code generators and other tools.
The complete contract of the API is published as an OpenAPI 3.1 document:
https://api.usedashly.com/v1/openapi.jsonIt is public: it needs no API key, because it describes the API, not your agency's data. Your agency's custom fields are not in it; read them with GET /v1/fields (see Custom fields).
curl -o dashly-openapi.json https://api.usedashly.com/v1/openapi.jsonWhat it contains
- Every resource, with its list, create, read, update and delete operations, as tagged groups.
- Every action, with the JSON Schema of its body. Deprecated actions are marked as such, with their removal date.
- The fields of each resource, the query parameters of each list, the error envelope and its codes, and the response headers (rate limits, quota, request id).
- The Bearer authentication scheme.
The document is generated from the same catalogue that serves the API, every time it is requested. It always describes the API as it runs today, and it changes when the API gains a resource, a field or an action. Fetch it again rather than keeping an old copy.
Use it with your tools
- In Postman, choose Import and paste
https://api.usedashly.com/v1/openapi.json. - Postman creates a collection with one request per operation.
- In the collection's Authorization settings, choose Bearer Token and use a variable such as
{{DASHLY_API_KEY}}, so the key is not saved in the collection.
The reference on this site
The API reference section of this site is generated from this document: one page per group of operations, with every field, parameter and response. When the API changes, the reference follows.