Professional API reference

Access for a legal professional to their own practice data on TheWILL.ai: their profile, appointments and booking figures, client approaches, clients, matters and their tasks, engagement letters, will reviews, conversations, invoices, revenue, commission statements, referrals, recorded time, rate cards, complaints, reviews, team, jurisdiction documents, regulatory alerts and the practice dashboard. It also lets you create will drafts for your own clients and produce a bulk export of your practice data.

Every list takes page_size and a cursor for the next page, and most take updated_since so an integration can fetch only what changed since its last sync. Register a webhook to be told when a client, will, invoice, complaint or task changes.

Authenticate with an API key sent as Authorization: Bearer twai_… (legacy keys: pk_…). A personal key reaches your own data; an organisation-wide key, which only a firm owner or admin can issue, reaches the data of every seat in the firm.

Read scopes

A key reads an endpoint when it holds pro:read or that endpoint's area scope. Scopes never imply one another, and creating will drafts needs pro:wills:write whatever read scopes the key holds.

  • pro:read — Everything in your practice: Read every area below, and start or download a full practice export.
  • pro:practice:read — Practice: Your profile, the practice dashboard and booking figures.
  • pro:clients:read — Clients: Clients, client approaches, engagement letters, conversations, and the wills drafted or reviewed for them.
  • pro:matters:read — Matters: Matters, their tasks and appointments.
  • pro:documents:read — Documents: Your practice's jurisdiction document library.
  • pro:billing:read — Billing: Invoices, revenue, commission statements, referrals, recorded time and rate cards.
  • pro:compliance:read — Compliance: Complaints, regulatory alerts and public reviews.
  • pro:team:read — Team: Your practice's team members.
  • Keep client and matter records
  • Send will instructions
  • Read and reply to client messages, and log complaints.
  • Manage appointments, client approaches, referrals and reviews.
  • Record time
  • Check your firm's compliance status and export its records.
  • Create wills for your own customers from your systems
  • Follow each will's progress and fetch its documents.
  • Keep customer and matter records in step between your systems…
  • Export your records and read the invoices for the wills…

51 operations · version 1.0.0

How to authenticate

Personal API key for portfolio consumer API. Format: Bearer twai_… (legacy keys: pk_…)

Authorization: Bearer twai_<prefix><secret><checksum>

Practice

Clients

Matters

Wills

Documents

For a professional: your jurisdiction documents and a download link for each. For a member: a short-lived download link for the original of each document in your personal vault.

Billing

Compliance

Team

The members of your firm and the role each one holds. With an organisation-wide key, every collection above covers every seat in the organisation.

Exports

Request a bulk export of your practice data, poll it until it is ready, then fetch the file through a signed, short-lived link.

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