Skip to main content
With the aiGust API, your software does what a user does in the portal: read figures, list administrations, create client users, and more. Anything your service user may do in the portal, it may do through the API.

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:
To find the ID of your firm, ask for the profile of your service user. The tenant in the response holds the id:

Before you start

  1. Get a client ID and secret.
  2. 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 a next value 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.
  • 401 and 403: see What the service user may do.

Use cases

Want to do something else with the API? Contact us at support@ai-gust.io.