Build on the IQ Entities API

Everything the app does goes through the IQ Entities REST API, so a script or another system can do the same: read the register into a data warehouse, create entities from a matter-intake system, keep registrations in step with a finance system. This guide is for the developer building it, and the administrator who gives them access.

Find the reference

1. Open Settings from the menu under your name, and choose API Documentation under AI & Integrations.

   

2. The reference lists every endpoint, with its parameters and the answer it returns. It is generated from the API itself, so it always matches what the app runs.

3. Click Download OpenAPI to save the whole contract as an OpenAPI document, for an API client or a code generator.

   

Call the API

1. An administrator creates an API key for the system, limited to what it needs: see Create an API key.

2. Send the key in the Authorization header of every request, as Bearer followed by the key. No sign-in or session is needed. API Keys in Settings shows an example request with your organisation's address.

3. The key works in the organisation it was created in, and nowhere else. A request its permissions do not cover is refused with 403.

Tips from practice

• Build against the downloaded OpenAPI document rather than copying endpoints by hand. Download it again after a release to pick up new endpoints.
• Changes made with a key appear in the audit trail with API as their source, so they can be told apart from changes made in the browser: see Review the audit trail.
• For an AI assistant, connect it instead of giving it a key. It gets the same operations as tools and there is no secret to look after: see Connect Claude to IQ Entities.
• If your organisation's plan does not include API access, the page says so. Talk to your account manager.