Skip to main content

​
Versions

The Qobra API is versioned. Breaking changes will occur when we change the version, and you’ll be notified by email two months in advance.
You are currently viewing the v1 API documentation. This version is fully functional. Its reporting endpoints are deprecated in favour of v2; every other v1 endpoint is maintained.
A v2 is available, and it covers reporting only — it is not a new version of the whole API. It brings significant improvements to reporting:
  • Data Structures: Tables containing your commission data (statements reporting and records reporting)
  • Schema Discovery: Dynamically inspect available fields and their types
  • ID-Based Pagination: Efficient navigation through large datasets using record IDs
Endpoints deprecated on v1, and their v2 replacement: New endpoints in v2: 👉 We strongly recommend migrating to v2 for all reporting use cases. Check out the v1 → v2 migration guide to facilitate your transition.
All other v1 endpoints — users, group and manager attributions, data tables and imports — stay on v1 and are maintained. They have no v2 equivalent and nothing to migrate. The deprecated reporting endpoints are still served and no removal date is announced: as with any breaking change, you would be notified by email two months in advance.

​
Authentication

​
Generate your API key

To authenticate your requests, you’ll need API keys, managed in Qobra’s global settings under the API section. Qobra API keys API Keys are strictly personal and based on the user account that generated the keys. Once you have retrieved those keys, you can authenticate to the API using request header

​
Request Header

To identify yourself, just put a header containing the API key as specified below.

​
Base URL

Qobra’s base api url is https://api.qobra.co/<version>/ For the first version of the api, you’ll have to call https://api.qobra.co/v1/