Bring Ignition data into your reporting tools so you can analyze firm-wide performance your way. The Reporting API gives you read-only access to your practice's data, so you can combine it with the rest of your tech stack in BI dashboards, spreadsheets and data warehouses.
Available to customers on Pro+ and Enterprise plans. On other plans, the Reporting API shows under More ways to build in the Developer hub, with an Upgrade to Pro+ button.
Looking to create or update data? The Reporting API is read-only. To create or update clients, proposals and invoices, or keep Ignition in sync with another system, use the Ignition API instead. It's available on every plan in Early access.
Connecting an AI assistant? You don't need either API. Use the Ignition MCP instead.
What the Reporting API does
The Reporting API lets you extract Ignition data and load it into your own reporting tools to build custom reports and analytics. It includes financial data the Ignition API doesn't, like settlements, fees, surcharges, disbursals and payment collections.
It's read-only, which means:
No data can be written back to Ignition
It can't keep Ignition in sync with another system
Existing Ignition data can't be changed through it
For the full list of available data, see the Reporting API developer documentation.
Before you begin
You need to be an Admin in your Ignition practice. The Reporting API reads data for the whole practice, so only Admins can create Reporting API apps.
Your practice needs to be on Pro+ or Enterprise.
You need a redirect URL. Reporting API apps connect through a one-time sign-in and approval, so every app needs at least one redirect URL. Whoever is setting up the connection will give you this. For a script on your own computer, use
http://127.0.0.1.
Please note: API keys can't reach Reporting API data. To use the Reporting API, create a Reporting API app as described below.
How to set up the Reporting API
Create an app
1. In Ignition, go to Settings → Developer hub.
2. In the OAuth apps section, select Create app.
3. Under Which API?, choose Reporting API.
4. Add an App name and Description so you can recognize the app later, for example "Firm revenue dashboard".
5. Add the Redirect URLs.
6. Select Create app.
Save your credentials
Once the app is created, Ignition shows a Client ID and Client secret. Select Copy both, or copy each one, and store them somewhere safe.
The secret is only shown once. If it's lost, select Regenerate secret from the app's ⋮ menu. The old secret stops working straight away, so anything using it will stop until it's updated.
Connect your reporting tool
Share the Client ID and Client secret with whoever is setting up the connection. They'll send you to an Ignition sign-in page to approve access once.
For the technical setup, including the sign-in flow and every available endpoint, see the Reporting API developer documentation.
Manage your apps
Your apps are listed in the OAuth apps section of the Developer hub, with the API each one uses, its Client ID, and when it was created and Last used. Select an app's three dots menu to Manage it, Regenerate secret or Delete app.
Tip: Create a separate app for each tool or service that reads your data. If two tools share one app's credentials, each time one refreshes its connection it can disconnect the other.
Important information
Only Admins can create and manage apps. Billing users can open the Developer hub to see apps, but can't change anything.
An app is tied to one API. A Reporting API app can't be switched to the Ignition API later, or the other way around.
Reporting API apps can't have webhooks. Webhooks are available on Ignition API apps only.
Requests are rate-limited. Reading data isn't counted toward an allowance.
Developer Platform Terms apply. They're linked when you create an app.
Related articles
Still have questions? Reach out to our support team via the chat bubble or at help@ignitionapp.com and we'll be happy to help.