The full reference
The complete API is documented in the API reference (ReDoc), with every endpoint, parameter and schema. This guide only explains the basics, and walks you through common use cases.Base URL
Build and test your integration on development, then switch to production. The examples in this guide use production.
Almost every endpoint sits under a firm, which the API calls a tenant:
tenant in the response holds the id:
Before you start
- Get a client ID and secret.
- Request an access token, and send it as a bearer token with every call.
Good to know
- Lists are paged. List endpoints take
page_size, and return anextvalue to fetch the next page. - IDs are UUIDs that aiGust creates, such as the ID of an administration. To find an administration by its VAT number, see Find an administration.
- Timestamps are ISO 8601, in UTC.
401and403: see What the service user may do.
Use cases
Want to do something else with the API? Contact us at support@ai-gust.io.