Developer access and API keys

The Developer hub is where you issue an API key, point webhooks at your own systems and watch how much of the API you are using. This guide explains what each part does and what the API can reach.

Last reviewed

What the developer hub is for

The Developer hub gives you programmatic access to your own account. It is a second way into data you can already see on screen, meant for a spreadsheet, a personal dashboard or a script that checks your records against another source. It is not a way to reach anyone else’s data.

The hub is six pages, linked from the row of page links at the top of each one:

  • Overview (/account/developer): a Your access card showing whether you can use test keys, live keys and webhooks, and a Get started list of three steps to your first call
  • API keys (/account/developer/keys): create, edit, rotate and revoke keys, with a Test / Live switch between your test keys and your live keys
  • Webhooks (/account/developer/webhooks): the endpoints we notify when your data changes, and the deliveries made to each
  • AI assistants (/account/developer/assistants): connect Claude, ChatGPT or another AI assistant, and manage the AI apps you signed in to
  • Usage and logs (/account/developer/usage): your usage against your plan’s limits, and one request log for all your keys
  • API reference (/account/developer/reference): every endpoint, parameter and response your keys can use, with a search field, a Try it console and a Download OpenAPI file button

Every page has its own address

Each page can be bookmarked or shared on its own. Older links to the Developer page, including ones that opened its former API docs or settings view, still work and lead to the matching page.

Issuing and using a key

To create a key, open the API keys page, choose Test or Live with the switch, enter a Key name and an Expires date, tick any extra scopes you want, then choose Create key. The key is sent as a bearer token on each request. The Get started steps on the Overview page take you from a test key to your first call: a request for your current holdings (or, in a professional view, your matters), which you can run from the API reference or copy for your terminal.

  • Treat a key as a password: anyone holding it can do what its scopes allow on your account, so keep it out of shared documents and out of anything published
  • Every key expires: you pick an expiry date when you create it, and the date picker enforces the longest lifetime allowed
  • How many you can hold depends on your plan: the hub shows your own allowance rather than a fixed number, so the figure on screen is the one that applies to you
  • Rotate rather than share: issue a separate key per tool, so retiring one integration does not break the others
  • Professional keys read by area: in a professional view the scope picker starts on Everything in your practice. Choose individual areas instead (Practice, Clients, Matters, Documents, Billing, Compliance or Team) to give a tool only what it needs. Each key in the list shows the areas it can read
  • Firm-wide keys can be tied to your network: an Organisation-wide key offers an optional Allowed IP addresses field, and Edit IP addresses in its ⋯ menu changes the list later. Calls from any other address are refused. Personal and test keys do not offer it

Managing a key after it is issued

Each key on the API keys page has a pencil icon (Edit), a history icon (Request log) and a list icon (History); Rotate key and Revoke key sit in the ⋯ menu. Edit changes the key’s name, the scopes it carries (only the scopes your plan allows are offered) and its expiry date, which must stay within the longest lifetime allowed. Choose Save changes to apply them.

  • Last used: each key shows when it was last used and, where recorded, from which address, so a key nobody uses, or one used from an address you do not recognise, stands out. A key never used reads Never used
  • Expiring soon: a key nearing its expiry date is marked Expiring soon on the API keys page, and we send an expiry warning email, so an integration does not stop without warning
  • Revoked keys: Show revoked keys lists the keys you have revoked, with when each was last used and revoked
  • Request log: opens the Usage and logs page filtered to that key: the calls it made, newest first, with the software that made each call where it identified itself. Clear the key filter to see every key’s requests in one list, or filter by status to find the calls that failed. Each record is kept for 90 days, then deleted automatically
  • Key history: lists what has happened to the key, newest first: when it was created, renamed or changed, rotated (and any scopes dropped because your plan no longer includes them), when its allowed IP addresses changed, when it expired and when it was revoked, including automatically because it was found in a public code repository. Each entry shows who did it, or System for automatic actions, and a revoked key’s history stays available

Rotating a key during a credential incident

If a key may have been exposed, replace its secret straight away. Rotating keeps the same key, with its name, scopes, expiry and usage history, and issues a new secret. The old secret stops working immediately, so the integration using it will fail until it has the new one.

  • 1. Rotate or create: choose Rotate key in the key’s ⋯ menu and confirm with Yes, rotate. If you would rather switch over without any interruption, create a second key with the same scopes instead, if your plan’s key allowance has room
  • 2. Copy the new secret: it is shown once only. Store it in the same secure place as the one it replaces
  • 3. Deploy: update the integration or tool to send the new secret
  • 4. Verify: make one request with the new secret and check the key’s Last used time updates on the API keys page
  • 5. Revoke: if you created a second key, revoke the old one. It then appears under Show revoked keys for your records

Trying a call before you write code

Every endpoint on the API reference page has a Try it panel. Fill in the fields it shows and choose Send request to see the status, how long the call took, how much of your hourly allowance is left and the response body, exactly as the API returned it. Copy as cURL gives you the same call for your terminal, with YOUR_API_KEY in place of a real key.

  • Demo data by default: the panel is labelled Demo data and runs on your demo workspace, not your real records. You do not need a key, and the call counts against your test allowance
  • A live key for read-only checks: if your plan includes API access, a read (GET) endpoint offers Use a live key. Paste a live key and the call runs on your real data, labelled Live data, and counts against that key’s allowance
  • The pasted key is never saved: it is kept on that page only. It is not stored in your browser, your account or the page address. Choose Forget key, or leave the page, and it is gone
  • Live calls are logged like any other: a call made with a pasted key appears in that key’s request log and in the request log on the Usage and logs page, just as if your own software had made it
  • Changes only on demo data: endpoints that create, change or cancel something can be tried on demo data only. A live key can run read requests here and nothing else

Screenshot, for illustration only

An endpoint in the API reference with its Try it panel open, labelled Demo data, showing the request fields, Send request and Copy as cURLAn endpoint in the API reference with its Try it panel open, labelled Demo data, showing the request fields, Send request and Copy as cURL
An endpoint in the API reference with its Try it panel open, labelled Demo data, showing the request fields, Send request and Copy as cURLAn endpoint in the API reference with its Try it panel open, labelled Demo data, showing the request fields, Send request and Copy as cURL
A Try it panel in the API reference, labelled Demo data. Fill in the fields, then choose Send request, or Copy as cURL to take the same call to your terminal.

Connecting an AI assistant

The AI assistants page has a Connect an AI assistant panel for linking Claude, ChatGPT or any other MCP-compatible assistant to your account. Name the assistant and choose Connect assistant: the panel creates a key carrying the scopes the assistant tools use and fills it into a setup you can copy into your assistant.

  • Copy the setup now: the key appears in the setup once only, like any new key. Once you choose I’ve saved it it is gone, and you will need a new one
  • Pick your assistant: there is a ready-made .mcp.json setup for Claude Code, and the address to add as a custom connector in the Claude apps or ChatGPT, which sign in with your account rather than a key
  • Test connection: paste a key and the panel sends one request through the same MCP server your assistant uses, then shows either the tools the assistant can reach or the exact reason the key was refused
  • Same list, same controls: the key appears on the API keys page with every other key, so you can edit its scopes, change its expiry date, check when it was last used or revoke it there
  • Signed-in AI apps: apps that sign in with your account rather than a key are listed separately under Connected AI apps, with a Manage connected apps button, where you can see what each can read and disconnect it

Without API access

If your plan does not include API access, the AI assistants page shows the plan panel described below in place of the Connect an AI assistant panel.

Webhooks and usage

Webhook endpoints

A webhook endpoint is an address of yours that we call when something changes, so your own system does not have to poll for it. Add and manage endpoints on the Webhooks page. Send test event on an endpoint shows the result under that endpoint straight away. Webhooks sit behind their own entitlement, separate from the API itself: when your plan does not include them the Webhooks page names the plan that does, and your API keys keep working on your current plan.

Usage figures

The Usage and logs page reports what your keys have actually called, so a loop firing more often than you intended shows up as a number rather than as a surprise.

Who can use the API

API access is a paid-plan feature. The Your access card on the Overview page shows test keys, live keys and webhooks one per row: each reads Available when your plan includes it, or names the plan that does with a View plans button. A row that no plan on sale includes for your account type reads Not on any current plan. On the API keys, AI assistants and Usage and logs pages, a plan without API access shows a panel naming the plan you need and listing what it unlocks, with a link to test keys while you wait: test keys work on demo data, so you can try the API before your plan includes live keys. If no plan on sale includes API access for your account type, the panel says so and asks you to contact us instead.

The hub loads a moment after the page, because the entitlement is read from your subscription rather than assumed. A brief placeholder in that gap is expected, not a failure.

The hub in a professional view

Switching to a professional or organisation view keeps the same six pages, but frames them for the professional API. The first call lists your matters rather than your holdings, the Your access card lists the practice areas a live key reads, and the API reference documents the professional API, with a link to the matter brief guide.

Older addresses still work

If you saved the Developer page or the API reference under an earlier portfolio address, those links still resolve. The hub now lives under your account, and the old addresses lead to the same place.

Can’t find what you’re looking for?

Our support team is here to help. Contact us and we’ll get back to you as soon as possible.

Contact us

We use cookies to improve your experience. See our Cookie policy (opens in a new tab) for details.