Aarre Public API
The Aarre Public API ("papi") gives your programs read access to the data your organisation holds with Aarre (writes are planned), over HTTPS and JSON. It is built for engineers at partners and shareholders, and for your own teams building integrations.
Status: v1 preview. No resource is callable yet. Five read-only resources are shown as a preview and open with v1: findings, business units, vocabulary, documents and sources. More resources will be added in place and listed in the changelog.
Base URL
Every path in this documentation is relative to your API base URL, for example:
https://api.example.com/api/public/v1Your actual base URL is given to you together with your API key.
Versioning in one line
Send a Papi-Version: YYYY-MM-DD header on every request. See Versioning.
How it works
- You receive an API key. It belongs to exactly one organisation and carries scopes such as
findings:read. - You exchange the key for a short-lived access token.
- You call the API with that token and the version header.
Your key only ever sees your own organisation's data.
Pages
- Getting started: from key to first call
- Authentication: keys, scopes, tokens, rotation, revocation
- Apps people sign in to (planned): apps that act for a person, chat included
- Versioning
- Responses and lists: response shape, paging, filters, caching
- Errors
- Rate limits
- Files (coming soon)
- Resources
- Findings (preview)
- Business units (preview)
- Vocabulary (preview)
- Documents (preview)
- Sources (preview)
- Changelog