Summary
Learn how Blimps self‑documents its API to help you understand what data you can request or update.
This article covers:
About Blimps API self‑documentation
The Blimps API is self‑documenting, meaning you can retrieve details about available resources directly from the API. By making an OPTIONS request, you can view supported resources, their fields, associations, and available filters without relying on separate documentation.
This is useful when:
- Building new integrations
- Validating fields before making API requests
- Troubleshooting unexpected API behaviour
Make an OPTIONS request to Blimps
Use an OPTIONS request to retrieve the full resource definition from your Box+Dice environment.
To make an OPTIONS request:
- Replace example.boxdice.com.au with your Box+Dice domain
- Replace admin:password with your API credentials
- Send an OPTIONS request to the Blimps endpoint
$ curl -u 'admin:password' -X OPTIONS http://example.boxdice.com.au/blimps
This will provide you with all the resources, attributes, associations and filters you may request, for example:
...
Contacts:
- fields:
- activityIds (format: array of integers, read only)
- categoryIds (format: array of integers, read only)
- email (format: string)
- firstName (format: string)
...