Professional API reference
Read access to your own portfolio: holdings, accounts, transactions, corporate actions, analytics, watchlists and import jobs. A key with the portfolio:write scope can also record transactions, upload broker statements for import, manage your watchlists and register webhooks. A key with the estate:read scope also reads your estate plan: wills and their progress, other assets, the people in your plan, guardian appointments, gifts, trusts, powers of attorney, funeral wishes, organ donation preferences, the stays, journeys and accommodation in your residency tracker, your to-do list, and the metadata of the documents in your personal vault. A key with the documents:read scope can also fetch a short-lived download link for the original of each vault document and for the PDF of each of your wills.
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.
Authenticate with a personal API key created under Account → Developer, sent as Authorization: Bearer twai_… (legacy keys: pk_…). A key only ever reaches the data of the member who created it.
- 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
- 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…
55 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>
api
Every appointment booked with you, most recently scheduled first. Each row carries the client it is with, its status and type, the scheduled start and end, how the appointment is held, and whether it was paid for or offered as a free consultation.
Only your own appointments are ever returned.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your matters” (pro:matters:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"client": 0,
"status": "RESERVED",
"appointment_type": "INITIAL_CONSULTATION",
"scheduled_start": "2026-01-31T09:00:00Z",
"scheduled_end": "2026-01-31T09:00:00Z",
"communication_mode": "IN_PERSON",
"is_paid": true,
"is_free_consultation": true,
"payment_amount": "0.00",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single appointment by id.
An id belonging to another professional answers 404 rather than 403, so the response never confirms that an appointment you cannot see exists.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your matters” (pro:matters:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"client": 0,
"status": "RESERVED",
"appointment_type": "INITIAL_CONSULTATION",
"scheduled_start": "2026-01-31T09:00:00Z",
"scheduled_end": "2026-01-31T09:00:00Z",
"communication_mode": "IN_PERSON",
"is_paid": true,
"is_free_consultation": true,
"payment_amount": "0.00",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Enquiries directed at you, newest first. An approach is a lead: someone has asked you to act, and may or may not have an account on the platform behind them.
Each row carries the kind of approach and its status, how urgent the enquirer said it was, where it came from, the service categories asked about, any fee you have quoted with its currency, the jurisdiction the work falls in, and when the approach was accepted.
Only approaches directed at you are ever returned.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"approach_type": "PROFESSIONAL",
"status": "NEW",
"urgency": "ROUTINE",
"source": "DIRECT",
"service_categories": null,
"quoted_fee": "0.00",
"quoted_currency": "string",
"is_priority": true,
"jurisdiction_country": "string",
"jurisdiction_state": "string",
"accepted_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single approach by id.
An id belonging to another professional answers 404 rather than 403, so the response never confirms that an approach you cannot see exists.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"approach_type": "PROFESSIONAL",
"status": "NEW",
"urgency": "ROUTINE",
"source": "DIRECT",
"service_categories": null,
"quoted_fee": "0.00",
"quoted_currency": "string",
"is_priority": true,
"jurisdiction_country": "string",
"jurisdiction_state": "string",
"accepted_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Booking figures for you over the reporting window chosen with ?period= (one of the values listed in period_options; 30 days when omitted): bookings made, cancellations, no-shows and completed appointments. Counts only, never client details. Your plan decides how much is included: the breakdowns by status, appointment type, source and day, and whether the figures cover your firm's whole team, appear only on plans that include them, exactly as on your dashboard. available_sections lists what your plan includes.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your practice profile” (pro:practice:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
periodquery · integerReporting window in days; one of
period_options.updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"period_days": 0,
"period_start": "2026-01-31T09:00:00Z",
"period_end": "2026-01-31T09:00:00Z",
"period_options": [
{
"value": 0,
"label": "string"
}
],
"period": 0,
"period_label": "string",
"period_start_date": "2026-01-31",
"period_end_date": "2026-01-31",
"basis_label": "string",
"rescheduled_note": "string",
"figure_labels": {},
"total_bookings": 0,
"overview_figure": {
"value": 0,
"label": "string",
"period_label": "string"
},
"by_status": [
{
"status": "string",
"label": "string",
"count": 0,
"share_percent": 0
}
],
"by_event_type": [
{
"event_type_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_type_name": "string",
"count": 0,
"share_percent": 0
}
],
"by_source": [
{
"source": "string",
"label": "string",
"count": 0,
"share_percent": 0
}
],
"cancellations": {
"total": 0,
"late": 0,
"late_share": 0,
"late_share_percent": 0
},
"no_shows": 0,
"missed_by_professional": 0,
"completed": 0,
"trend": [
{
"date": "2026-01-31",
"count": 0
}
],
"funnel": {
"views": 0,
"started": 0,
"completed": 0,
"start_rate": 0,
"completion_rate": 0,
"has_activity": true,
"scope_note": "string",
"steps": [
{
"key": "string",
"label": "string",
"count": 0,
"percent_of_opened": 0
}
]
},
"funnel_trend": [
{
"date": "2026-01-31",
"views": 0,
"started": 0,
"completed": 0
}
],
"analytics_grade": "string",
"available_sections": [
"string"
],
"required_plan": "string",
"required_plan_name": "string"
}
],
"page_size": 100
}Every client you act for, most recently changed first: the same clients your dashboard lists. Each row carries the client's name, your reference for them, the state of the relationship, whether they have their own account with us and whether their identity has been verified.
Contact details follow the same rule as your dashboard. Details you entered yourself are always included. Details that came from the client's own account are null until the client has signed an engagement letter with you; contact_released tells you which applies to a row.
A client who withdraws from the relationship leaves this list. With updated_since, a withdrawn client is reported as a deleted row so your copy can drop them too.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"first_name": "string",
"last_name": "string",
"client_reference": "string",
"status": "ACTIVE",
"has_linked_account": true,
"identity_verified": true,
"contact_released": true,
"email": "name@example.com",
"phone_country_code": "string",
"phone": "string",
"date_of_birth": "2026-01-31",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"post_code": "string",
"country": "string",
"last_activity_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single client by id.
An id belonging to another professional, or to a client who has withdrawn, answers 404 rather than 403, so the response never confirms that a client you cannot see exists.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"first_name": "string",
"last_name": "string",
"client_reference": "string",
"status": "ACTIVE",
"has_linked_account": true,
"identity_verified": true,
"contact_released": true,
"email": "name@example.com",
"phone_country_code": "string",
"phone": "string",
"date_of_birth": "2026-01-31",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"post_code": "string",
"country": "string",
"last_activity_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Which estate documents the client has (their will, lasting powers of attorney and other supported documents), whether each is not_started, in_progress or done, when a finished document was last reviewed, and why it may need a fresh look (needs_review). Never what a document says, who is named in it or what the estate is worth.
Shared only while the client has agreed that your firm may see it. The agreement is re-read on every call: a client who withdraws it stops the very next fetch.
Errors:
| Status | When | | --- | --- | | 401 | No Authorization: Bearer twai_… (or legacy pk_…) header, or an unknown key | | 403 | The client has not agreed to share this status with your firm, or has withdrawn that agreement; or the key lacks the pro:read scope, or the plan lacks pro.api_access | | 404 | The client is not yours, has withdrawn, or does not exist | | 429 | Rate limit for your plan exceeded |
The response carries Cache-Control: no-store.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string · required
Responses
{
"client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documents": [
{
"document_type": "WILL",
"label": "string",
"state": "not_started",
"last_reviewed_at": "2026-01-31T09:00:00Z",
"needs_review": [
{
"code": "document_age",
"label": "string"
}
]
}
]
}The platform's commission invoices charged to you, most recently issued first. It is the same set your dashboard's commission statements page lists.
Amounts are decimal strings in currency. vat_country and reverse_charge record how tax on the commission was determined.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"invoice_number": "string",
"description": "string",
"status": "ISSUED",
"service_invoice": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"commission_amount": "0.00",
"vat_rate": "0.00",
"vat_amount": "0.00",
"vat_country": "string",
"reverse_charge": true,
"total_amount": "0.00",
"period_start": "2026-01-31",
"period_end": "2026-01-31",
"issued_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single commission statement by id; a foreign id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this platform commission invoice.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"invoice_number": "string",
"description": "string",
"status": "ISSUED",
"service_invoice": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"commission_amount": "0.00",
"vat_rate": "0.00",
"vat_amount": "0.00",
"vat_country": "string",
"reverse_charge": true,
"total_amount": "0.00",
"period_start": "2026-01-31",
"period_end": "2026-01-31",
"issued_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Complaints made against you, newest first: the same set your dashboard's complaints page lists. deadline_date is the date the complaint must be answered by and is_overdue says whether that date has passed without an answer.
This collection's updated_since feed reports changed rows only; a row deleted since your last walk is not listed, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your compliance records” (pro:compliance:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"appointment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"complainant_name": "string",
"category": "SERVICE_QUALITY",
"category_display": "string",
"subject": "string",
"description": "string",
"status": "SUBMITTED",
"status_display": "string",
"deadline_date": "2026-01-31",
"is_overdue": true,
"acknowledged_at": "2026-01-31T09:00:00Z",
"professional_response": "string",
"professional_responded_at": "2026-01-31T09:00:00Z",
"investigation_started_at": "2026-01-31T09:00:00Z",
"resolution": "string",
"resolved_at": "2026-01-31T09:00:00Z",
"escalated_at": "2026-01-31T09:00:00Z",
"escalated_to": "string",
"escalated_to_code": "LEGAL_OMBUDSMAN",
"escalation_reference": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single complaint against you; any other id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your compliance records” (pro:compliance:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this complaint.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"appointment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"complainant_name": "string",
"category": "SERVICE_QUALITY",
"category_display": "string",
"subject": "string",
"description": "string",
"status": "SUBMITTED",
"status_display": "string",
"deadline_date": "2026-01-31",
"is_overdue": true,
"acknowledged_at": "2026-01-31T09:00:00Z",
"professional_response": "string",
"professional_responded_at": "2026-01-31T09:00:00Z",
"investigation_started_at": "2026-01-31T09:00:00Z",
"resolution": "string",
"resolved_at": "2026-01-31T09:00:00Z",
"escalated_at": "2026-01-31T09:00:00Z",
"escalated_to": "string",
"escalated_to_code": "LEGAL_OMBUDSMAN",
"escalation_reference": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Every regulatory requirement that applies to you and is not yet met, as your dashboard lists them. A requirement disappears once a verified credential covers it or you have declared it does not apply; while a credential you hold awaits verification it stays listed with pending_verification true. The list is computed each time, so it is returned whole rather than paged.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your compliance records” (pro:compliance:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"count": 0,
"results": [
{
"code": "string",
"country": "string",
"title": "string",
"description": "string",
"severity": "string",
"has_credential": true,
"credential_verified": true,
"pending_verification": true,
"start_date": "string",
"deadline": "string",
"deadline_approximate": "string",
"cohort_windows": [
{}
],
"declarable": true,
"action_url": "string"
}
]
}
],
"page_size": 100
}Every conversation you take part in, archived ones included, the most recently active first: the same threads your inbox shows, with the same row. Until a client has signed your engagement letter their details are limited exactly as they are in your inbox, and contact details in a message preview stay masked until your first booking with them.
updated_at moves when the conversation itself changes. A thread's messages, including new and edited ones, are read from its messages/ collection.
A conversation you delete from your inbox leaves this collection; its updated_since feed reports changed rows only, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"conversation_type": "C2P",
"status": "ACTIVE",
"source": "DIRECT",
"subject": "string",
"subject_is_auto": true,
"request_state": "ACTIVE",
"can_respond_to_request": true,
"last_message_at": "2026-01-31T09:00:00Z",
"last_message_preview": "string",
"last_message_sender_name": "string",
"last_message_is_mine": true,
"last_message_is_system": true,
"other_participant": {},
"consumer_context": {},
"consumer_context_is_own": true,
"my_unread_count": 0,
"is_muted": true,
"is_archived": true,
"has_draft": true,
"blocked_by_me": true,
"is_admin_frozen": true,
"mirror_consumers": [
{
"user_id": "string",
"full_name": "string"
}
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}The messages of one conversation you take part in, oldest first, as your inbox shows them: a deleted message keeps its place with is_deleted true and empty content, and contact details stay masked until your first booking with the client (contact_details_masked). A message carrying a file names it in file_name; open the file from your dashboard.
updated_at is the latest of when the message was sent, edited and deleted, so an updated_since walk returns new messages and those edited or deleted since. A conversation you cannot read answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
conversationPkpath · string · requiredcursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"conversation": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sender": 0,
"sender_name": "string",
"message_type": "TEXT",
"metadata": null,
"content": "string",
"file_name": "string",
"file_size": 0,
"file_mime_type": "string",
"is_compressed": true,
"is_deleted": true,
"edited_at": "2026-01-31T09:00:00Z",
"is_read_by_me": true,
"is_read_by_other": true,
"timestamp": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single message of the conversation; any other id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
conversationPkpath · string · requiredidpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"conversation": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sender": 0,
"sender_name": "string",
"message_type": "TEXT",
"metadata": null,
"content": "string",
"file_name": "string",
"file_size": 0,
"file_mime_type": "string",
"is_compressed": true,
"is_deleted": true,
"edited_at": "2026-01-31T09:00:00Z",
"is_read_by_me": true,
"is_read_by_other": true,
"timestamp": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}A single conversation you take part in; any other id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"conversation_type": "C2P",
"status": "ACTIVE",
"source": "DIRECT",
"subject": "string",
"subject_is_auto": true,
"request_state": "ACTIVE",
"can_respond_to_request": true,
"last_message_at": "2026-01-31T09:00:00Z",
"last_message_preview": "string",
"last_message_sender_name": "string",
"last_message_is_mine": true,
"last_message_is_system": true,
"other_participant": {},
"consumer_context": {},
"consumer_context_is_own": true,
"my_unread_count": 0,
"is_muted": true,
"is_archived": true,
"has_draft": true,
"blocked_by_me": true,
"is_admin_frozen": true,
"mirror_consumers": [
{
"user_id": "string",
"full_name": "string"
}
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The practice-overview figures your dashboard shows: new business, work in hand, revenue, open complaints and wills held, over the reporting window chosen with ?period= (one of the values listed in period_options; 30 days when omitted). Each figure carries its value for the previous window of the same length where there is one. The figures are recomputed at most once a minute, so a change can take up to a minute to show.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your practice profile” (pro:practice:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
periodquery · integerReporting window in days; one of
period_options.updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"period_days": 0,
"period_start": "2026-01-31T09:00:00Z",
"period_end": "2026-01-31T09:00:00Z",
"period_options": [
{
"value": 0,
"label": "string"
}
],
"period_label": "string",
"comparison_label": "string",
"new_business_heading": "string",
"work_in_hand_heading": "string",
"has_prior_period": true,
"new_business": [
{
"key": "string",
"label": "string",
"value": 0,
"previous_value": 0,
"delta": 0,
"comparison_basis": "delta",
"conversion_from_previous_stage": 0,
"conversion_caption": "string"
}
],
"conversion_note": "string",
"work_in_hand": [
{
"key": "string",
"label": "string",
"value": 0,
"previous_value": 0,
"delta": 0,
"comparison_basis": "delta"
}
],
"revenue": {
"has_invoicing_history": true,
"currency": "string",
"has_multiple_currencies": true,
"outstanding": {
"count": 0,
"value": "0.00"
},
"overdue": {
"count": 0,
"value": "0.00"
},
"invoiced_in_period": {
"count": 0,
"value": "0.00"
},
"invoiced_previous_period": {
"count": 0,
"value": "0.00"
},
"invoiced_delta": "0.00",
"invoiced_comparison_basis": "delta",
"invoiced_period_start": "2026-01-31",
"outstanding_label": "string",
"overdue_line": "string",
"overdue_alert": true,
"invoiced_label": "string",
"invoiced_comparison_label": "string",
"empty_message": "string"
},
"complaints": {
"open_count": 0,
"oldest_open_age_days": 0,
"nearest_deadline": "2026-01-31",
"deadline_state": "string"
},
"custody": {
"wills_held": 0
}
}
],
"page_size": 100
}The regulatory documents you have filed against your jurisdictions (licences, practising and insurance certificates, identity and address proofs), newest first: the same documents your dashboard's documents page shows. jurisdiction is the jurisdiction the document was filed against. can_download says whether documents/{id}/download/ will hand over the file right now; it is false while the security scan is still running.
This collection's updated_since feed reports changed rows only; a row deleted since your last walk is not listed, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your practice documents” (pro:documents:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jurisdiction": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "LICENSE",
"document_type_display": "string",
"document_name": "string",
"status": "PENDING",
"status_display": "string",
"verified_at": "2026-01-31T09:00:00Z",
"rejection_reason": "string",
"expiry_date": "2026-01-31",
"is_expired": true,
"file_type": "string",
"file_size": 0,
"mime_type": "string",
"virus_scan_status": "string",
"can_download": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single document of yours; any other id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your practice documents” (pro:documents:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jurisdiction": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "LICENSE",
"document_type_display": "string",
"document_name": "string",
"status": "PENDING",
"status_display": "string",
"verified_at": "2026-01-31T09:00:00Z",
"rejection_reason": "string",
"expiry_date": "2026-01-31",
"is_expired": true,
"file_type": "string",
"file_size": 0,
"mime_type": "string",
"virus_scan_status": "string",
"can_download": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The file of one document on documents/, exactly when your dashboard would let you download it.
Errors:
| Status | When | | --- | --- | | 202 | The security scan is still running; try again shortly | | 401 | No Authorization: Bearer twai_… (or legacy pk_…) header, or an unknown key | | 403 | Key lacks the pro:read scope, the plan lacks pro.api_access, or the file failed the security scan | | 404 | The document is not yours, or has no file | | 429 | Rate limit exceeded |
Every download is recorded in the document's history. The response carries Cache-Control: no-store.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your practice documents” (pro:documents:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
"string"
The engagement letters you have issued, newest first, with the approach each one answers.
Each row carries the letter's status and version number, the fee quoted with its currency, and the lifecycle timestamps: when the letter was sent, when it was first viewed, and when it was signed. A timestamp that has not happened yet is null, so an unsigned letter is one with a sent_at and no signed_at.
Only your own letters are ever returned. The letter's text is not included; this lane reports status, not content.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"approach": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "DRAFT",
"version_number": 0,
"quoted_fee": "0.00",
"quoted_currency": "string",
"sent_at": "2026-01-31T09:00:00Z",
"viewed_at": "2026-01-31T09:00:00Z",
"signed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single engagement letter by id.
An id belonging to another professional answers 404 rather than 403, so the response never confirms that a letter you cannot see exists.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"approach": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "DRAFT",
"version_number": 0,
"quoted_fee": "0.00",
"quoted_currency": "string",
"sent_at": "2026-01-31T09:00:00Z",
"viewed_at": "2026-01-31T09:00:00Z",
"signed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Starts building one archive of your practice's records, the same bundle the dashboard's data export produces. The build runs in the background: poll exports/{id}/ until status is completed, then fetch download_url.
The body names how the archive is protected: protection is age_passphrase or zip_aes (with passphrase, at least 12 characters), age_recipient (with public_key, an age1... key), or none. none is accepted only with confirm_unprotected: true, which is audit-logged. A request without one answers 400.
Only one export can be building at a time; a second request while one is pending or processing answers 409 with that job in job. Needs the pro:read scope. Every request is recorded in your practice's audit log.
What it needs
Needs a key with the permission “Read every area of your practice” (pro:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Request body
application/jsonprotectionone of: age_passphrase, age_recipient, zip_aes, noneage_passphrase- Encrypted file (age) opened with a passphraseage_recipient- Encrypted file (age) for your public keyzip_aes- Password-protected ZIP (AES-256)none- Unprotected ZIP
passphrasestringpublic_keystringconfirm_unprotectedboolean
{
"protection": "age_passphrase",
"passphrase": "string",
"public_key": "string",
"confirm_unprotected": false
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"scope": "professional",
"status": "pending",
"status_display": "string",
"is_active": true,
"can_download": true,
"row_counts": null,
"protection_mode": "string",
"expires_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"completed_at": "2026-01-31T09:00:00Z",
"download_url": "string",
"download_expires_in": "string"
}The status of one export you requested. While status is pending or processing the bundle is still being built. Once it is completed, download_url is a signed link to the archive, valid for download_expires_in seconds and usable without your key. Poll again for a fresh link after it lapses. Revoking the key that minted a link stops the link at once. download_url is null for any other status, and after expires_at the bundle is gone.
Answers 404 for an export that is not yours.
What it needs
Needs a key with the permission “Read every area of your practice” (pro:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"scope": "professional",
"status": "pending",
"status_display": "string",
"is_active": true,
"can_download": true,
"row_counts": null,
"protection_mode": "string",
"expires_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"completed_at": "2026-01-31T09:00:00Z",
"download_url": "string",
"download_expires_in": "string"
}The archive itself. Reached through the download_url an exports/{id}/ poll returns. The signed token is the credential, so no Authorization header is needed. Answers 404 once the link has lapsed, the key that minted it has been revoked, or the export has expired. Every download is recorded in your practice's audit log. The response carries Cache-Control: no-store.
What it needs
No key: the signed link returned by GET exports/{id}/ (its download_url) is the credential.
Parameters
idpath · string · requiredtokenquery · string · requiredThe signed token from
download_url.
Responses
"string"
Stages a file in your practice's import, exactly as uploading it on the dashboard does: nothing is imported yet. Send file and kind (the same kinds the dashboard offers) as multipart form data, plus sheet to choose one sheet of a workbook. Accepts the same file types as the dashboard.
Every request must carry an Idempotency-Key header: a retry with the same key and file answers the first result and stages nothing new. Your practice is emailed and alerted each time a key uploads a file. Needs the pro:imports:write scope.
What it needs
Needs a key with the permission “Upload files to check and import into your practice” (pro:imports:write) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.
Responses
{}The import's status and counts. While it is staged, preview holds what an import would do now (new, updated, skipped, conflicting and failing rows) and any required field the mapping still lacks. errors_url lists the rows that will not import, with the reason. Answers 404 for an import that is not your practice's.
What it needs
Needs a key with the permission “Upload files to check and import into your practice” (pro:imports:write) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
{}Imports every valid row of a staged import and reports the rest. Client records import only once your practice has confirmed the Processor Terms (an owner or admin does this once, on the dashboard); until then the request answers 403 with code firm_terms_required and nothing is imported. No per-import confirmation is needed: client_authorisation_confirmed, sent by older integrations, is accepted and ignored. Your practice is emailed and alerted each time a key imports a file.
What it needs
Needs a key with the permission “Upload files to check and import into your practice” (pro:imports:write) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Responses
{}A CSV of the rows that did not (or, while staged, would not) import, each with the reason. Cells are written so a spreadsheet never runs them as formulas.
What it needs
Needs a key with the permission “Upload files to check and import into your practice” (pro:imports:write) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
"string"
Every invoice you have raised, drafts included, newest first: the same set the Invoices page of your dashboard lists.
Amounts are decimal strings in the invoice's currency (ISO 4217). vat_rate/vat_amount are the tax charged; tax_info names which tax that is (VAT, GST, sales tax) for your jurisdiction, so never assume a label or a rate.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"invoice_number": "string",
"status": "DRAFT",
"client": 0,
"matter": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"invoice_date": "2026-01-31",
"due_date": "2026-01-31",
"currency": "string",
"subtotal": "0.00",
"discount_amount": "0.00",
"vat_rate": "0.00",
"vat_amount": "0.00",
"tax_info": "string",
"total_amount": "0.00",
"amount_paid": "0.00",
"balance_due": "0.00",
"sent_date": "2026-01-31T09:00:00Z",
"paid_date": "2026-01-31T09:00:00Z",
"cancelled_date": "2026-01-31T09:00:00Z",
"written_off_at": "2026-01-31T09:00:00Z",
"disputed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single invoice by id. An id you did not raise answers 404 rather than 403.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this invoice.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"invoice_number": "string",
"status": "DRAFT",
"client": 0,
"matter": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"invoice_date": "2026-01-31",
"due_date": "2026-01-31",
"currency": "string",
"subtotal": "0.00",
"discount_amount": "0.00",
"vat_rate": "0.00",
"vat_amount": "0.00",
"tax_info": "string",
"total_amount": "0.00",
"amount_paid": "0.00",
"balance_due": "0.00",
"sent_date": "2026-01-31T09:00:00Z",
"paid_date": "2026-01-31T09:00:00Z",
"cancelled_date": "2026-01-31T09:00:00Z",
"written_off_at": "2026-01-31T09:00:00Z",
"disputed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Tasks on the matters you can act on, your own and your firm's: the same set your dashboard's task list shows. matter is the id used by the matters/ collection, so a task can be joined to its matter there.
This collection's updated_since feed reports changed rows only; a row deleted since your last walk is not listed, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your matters” (pro:matters:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"matter": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"description": "string",
"status": "TODO",
"status_display": "string",
"due_date": "2026-01-31",
"is_overdue": true,
"assigned_to_name": "string",
"position": 0,
"completed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single task; one outside your matters answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your matters” (pro:matters:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this Matter task.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"matter": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"description": "string",
"status": "TODO",
"status_display": "string",
"due_date": "2026-01-31",
"is_overdue": true,
"assigned_to_name": "string",
"position": 0,
"completed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}PII-free by construction: no client name, contact detail, free text or monetary figure appears here. Use brief_available to see which matters the client has currently consented to share, and brief_expires_at for when that consent lapses.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your matters” (pro:matters:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"approach_type": "PROFESSIONAL",
"status": "NEW",
"urgency": "ROUTINE",
"source": "DIRECT",
"service_categories": null,
"is_priority": true,
"jurisdiction_country": "string",
"jurisdiction_state": "string",
"accepted_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z",
"brief_available": "string",
"brief_expires_at": "string"
}
],
"page_size": 100
}Returns the scoped matter brief for one matter, and only while the client's consent for that matter is live. The consent is re-read on every call, never cached: a client who revokes, or a consent that expires, stops the very next fetch.
Errors:
| Status | When | | --- | --- | | 401 | No Authorization: Bearer twai_… (or legacy pk_…) header, or an unknown key | | 403 | Key lacks the pro:read scope, or the plan lacks pro.api_access | | 404 | The matter is not yours, does not exist, or the client has no live consent for it (deliberately indistinguishable) | | 429 | Rate limit for your plan exceeded |
Pin on the MAJOR component of schema_version only. The response carries Cache-Control: no-store: it is a client's personal information and must not be written to a shared or on-disk cache.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your matters” (pro:matters:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string · required
Responses
{
"export_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"schema_version": "string",
"issued_at": "2026-01-31T09:00:00Z",
"expires_at": "2026-01-31T09:00:00Z",
"matter_reference": "string",
"recipient": {},
"grant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"handling_notice": "string",
"third_party_data_sections": [
{}
],
"brief": {},
"sections": [
{}
]
}The profile and practice details of the professional your API key belongs to. A key can only ever read its own profile, so this endpoint takes no identifier.
practice carries the firm's name, trading name, type and regulatory registration when the professional belongs to a firm, and is null for a sole practitioner.
Answers 404 when the account behind the key has no professional profile attached to it.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your practice profile” (pro:practice:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Responses
Rate cards you own and those of firms you belong to, each with its priced items. vat_rate/vat_inclusive state the card's tax position and tax_info names the tax for the card's jurisdiction.
An updated_since walk also reports rows deleted since then, including deletions made by the other party or by a colleague at your firm. A row that leaves the list without being deleted (a rate card whose jurisdiction was removed, a matter you can no longer see) is not reported, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"owner_type": "string",
"currency": "GBP",
"vat_rate": "0.00",
"vat_inclusive": true,
"tax_info": "string",
"valid_from": "2026-01-31",
"valid_to": "2026-01-31",
"is_active": true,
"is_default": true,
"payment_terms_days": 0,
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"service_category": "WILL_SIMPLE",
"service_name": "string",
"service_description": "string",
"billing_method": "HOURLY",
"standard_rate": "0.00",
"urgent_rate": "0.00",
"out_of_hours_rate": "0.00",
"time_unit": "HOUR",
"minimum_charge": "0.00",
"vat_applicable": true,
"vat_rate_override": "0.00"
}
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single rate card; one you cannot see answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this rate card.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"owner_type": "string",
"currency": "GBP",
"vat_rate": "0.00",
"vat_inclusive": true,
"tax_info": "string",
"valid_from": "2026-01-31",
"valid_to": "2026-01-31",
"is_active": true,
"is_default": true,
"payment_terms_days": 0,
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"service_category": "WILL_SIMPLE",
"service_name": "string",
"service_description": "string",
"billing_method": "HOURLY",
"standard_rate": "0.00",
"urgent_rate": "0.00",
"out_of_hours_rate": "0.00",
"time_unit": "HOUR",
"minimum_charge": "0.00",
"vat_applicable": true,
"vat_rate_override": "0.00"
}
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Referrals you made to, or received from, another professional. role says which side you are on. Fees are decimal strings in currency, with the tax on the referral fee reported separately.
An updated_since walk also reports rows deleted since then, including deletions made by the other party or by a colleague at your firm. A row that leaves the list without being deleted (a rate card whose jurisdiction was removed, a matter you can no longer see) is not reported, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"role": "string",
"referrer": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"receiver": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "INITIATED",
"matter_type": "WILL",
"engagement_basis": "REFERRAL",
"is_pi_laspo_matter": true,
"referrer_country": "string",
"receiver_country": "string",
"settlement_mode": "RECORD_AND_DISCLOSE",
"fee_percent_snapshot": "0.00",
"currency": "string",
"matter_fee_pre_vat": "0.00",
"referral_fee_gross": "0.00",
"referral_fee_vat_rate": "0.00",
"referral_fee_vat_amount": "0.00",
"referral_fee_net": "0.00",
"referrer_payout_amount": "0.00",
"cancelled_at": "2026-01-31T09:00:00Z",
"disputed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single referral you are party to; any other id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this Professional referral.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"role": "string",
"referrer": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"receiver": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "INITIATED",
"matter_type": "WILL",
"engagement_basis": "REFERRAL",
"is_pi_laspo_matter": true,
"referrer_country": "string",
"receiver_country": "string",
"settlement_mode": "RECORD_AND_DISCLOSE",
"fee_percent_snapshot": "0.00",
"currency": "string",
"matter_fee_pre_vat": "0.00",
"referral_fee_gross": "0.00",
"referral_fee_vat_rate": "0.00",
"referral_fee_vat_amount": "0.00",
"referral_fee_net": "0.00",
"referrer_payout_amount": "0.00",
"cancelled_at": "2026-01-31T09:00:00Z",
"disputed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Billed, collected, ageing and top-client figures for your practice over a reporting period. These are the same figures your dashboard's revenue analytics page shows, computed by the same service.
?period= picks the window (the accepted values are returned as period_options); ?currency= picks one of the currencies you have invoiced in (currency_options). An unsupported period or a currency you have never invoiced in answers 400 rather than falling back to a default.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"period_days": 0,
"period_start": "2026-01-31T09:00:00Z",
"period_end": "2026-01-31T09:00:00Z",
"period_options": [
{
"value": 0,
"label": "string"
}
],
"period": 0,
"period_label": "string",
"period_start_date": "2026-01-31",
"period_end_date": "2026-01-31",
"has_invoicing_history": true,
"currency": "string",
"currency_options": [
{
"value": "string",
"label": "string",
"invoice_count": 0
}
],
"billed": {
"count": 0,
"value": "0.00"
},
"collected": {
"count": 0,
"value": "0.00"
},
"collection_rate": 0,
"average_days_to_pay": 0,
"billed_hint": "string",
"collected_hint": "string",
"average_days_to_pay_hint": "string",
"collection_ratio_hint": "string",
"series_granularity": "day",
"series_granularity_label": "string",
"series": [
{
"bucket_start": "2026-01-31",
"bucket_end": "2026-01-31",
"label": "string",
"billed": "0.00",
"collected": "0.00",
"marketplace_fee": "0.00",
"net": "0.00"
}
],
"ageing": [
{
"key": "string",
"label": "string",
"count": 0,
"value": "0.00"
}
],
"ageing_total": {
"count": 0,
"value": "0.00"
},
"top_clients": [
{
"client_id": 0,
"client_name": "string",
"count": 0,
"value": "0.00"
}
],
"written_off": {
"count": 0,
"value": "0.00"
},
"disputed": {
"count": 0,
"value": "0.00"
},
"unattributed_payments": {
"count": 0,
"value": "0.00"
},
"marketplace_fee": "0.00",
"marketplace_fee_label": "string",
"net": "0.00",
"net_label": "string",
"home_currency_total": {
"currency": "string",
"value": "0.00",
"unavailable_note": "string",
"label": "string",
"indicative": true,
"included_currencies": [
"string"
],
"excluded": [
{
"currency": "string",
"note": "string"
}
],
"rate_source": "string",
"rate_provider": "string",
"rate_basis": "string",
"rate_date_from": "2026-01-31",
"rate_date_to": "2026-01-31",
"rate_dates_label": "string"
}
}
],
"page_size": 100
}Published client reviews of you, newest first, with any response you have posted. Reviews still awaiting moderation, or rejected by it, are not listed, exactly as they are not shown on your profile.
This collection's updated_since feed reports changed rows only; a row deleted since your last walk is not listed, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your compliance records” (pro:compliance:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"appointment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overall_rating": "0.00",
"communication_rating": 0,
"service_quality_rating": 0,
"value_rating": 0,
"timeliness_rating": 0,
"review_title": "string",
"review_text": "string",
"service_date": "2026-01-31",
"would_recommend": true,
"verified_purchase": true,
"professional_response": "string",
"response_date": "2026-01-31T09:00:00Z",
"response_status": "NONE",
"pending_response": "string",
"response_rejection_reason": "string",
"published_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single published review of you; an unpublished or foreign id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your compliance records” (pro:compliance:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this review.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"appointment": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"overall_rating": "0.00",
"communication_rating": 0,
"service_quality_rating": 0,
"value_rating": 0,
"timeliness_rating": 0,
"review_title": "string",
"review_text": "string",
"service_date": "2026-01-31",
"would_recommend": true,
"verified_purchase": true,
"professional_response": "string",
"response_date": "2026-01-31T09:00:00Z",
"response_status": "NONE",
"pending_response": "string",
"response_rejection_reason": "string",
"published_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The seats on your firm's roster, with each member's role and status (active, on leave, suspended): the same roster your dashboard's team page shows. Members who have been removed are not listed. Needs a firm on a plan with team seats and a role allowed to view the team; otherwise 403.
This collection's updated_since feed reports changed rows only; a row deleted since your last walk is not listed, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your team” (pro:team:read) and the plan features “API Access” and “Multi-User Seats”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Your role in the firm must include the 'team.view' permission.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"role": "owner",
"role_display": "string",
"title": "string",
"status": "active",
"status_display": "string",
"leave_return_date": "2026-01-31",
"department_name": "string",
"office_name": "string",
"joined_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single seat on your roster; any other id answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your team” (pro:team:read) and the plan features “API Access” and “Multi-User Seats”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Your role in the firm must include the 'team.view' permission.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this organization membership.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"role": "owner",
"role_display": "string",
"title": "string",
"status": "active",
"status_display": "string",
"leave_return_date": "2026-01-31",
"department_name": "string",
"office_name": "string",
"joined_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Time recorded on matters you can act on, your own and your firm's, exactly as your dashboard's time ledger shows it. billable_minutes, billable_hours and amount apply the entry's billing increment, so they match what an invoice will charge; amount excludes tax, and fee_tax_stance says how tax applies to it.
An updated_since walk also reports rows deleted since then, including deletions made by the other party or by a colleague at your firm. A row that leaves the list without being deleted (a rate card whose jurisdiction was removed, a matter you can no longer see) is not reported, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"matter": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fee_earner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"work_date": "2026-01-31",
"duration_minutes": 0,
"billing_increment_minutes": 0,
"billable_minutes": 0,
"billable_hours": "0.00",
"narrative": "string",
"rate_source": "RATE_CARD",
"hourly_rate": "0.00",
"currency": "string",
"amount": "0.00",
"fee_tax_stance": "string",
"status": "UNBILLED",
"written_off_reason": "string",
"written_off_reason_code": "RECORDED_IN_ERROR",
"written_off_reason_code_display": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single time entry; one outside your matters answers 404.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your billing” (pro:billing:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this time entry.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"matter": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fee_earner": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"work_date": "2026-01-31",
"duration_minutes": 0,
"billing_increment_minutes": 0,
"billable_minutes": 0,
"billable_hours": "0.00",
"narrative": "string",
"rate_source": "RATE_CARD",
"hourly_rate": "0.00",
"currency": "string",
"amount": "0.00",
"fee_tax_stance": "string",
"status": "UNBILLED",
"written_off_reason": "string",
"written_off_reason_code": "RECORDED_IN_ERROR",
"written_off_reason_code_display": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Every will review you are assigned to, pending and completed, most recently changed first: the same reviews your dashboard lists. reviewer_role is main where you lead the review and additional where you contribute recommendations.
will_id is the reviewed will's id on /ext/wills/. A review stays on this list when it ends; its status says how it ended.
The updated_since feed reports changed reviews only. A review that leaves this list because it was deleted or you were taken off it is not listed, so re-walk the collection periodically to reconcile.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"will_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"status_label": "string",
"review_type": "string",
"reviewer_role": "string",
"requested_at": "2026-01-31T09:00:00Z",
"assigned_at": "2026-01-31T09:00:00Z",
"started_at": "2026-01-31T09:00:00Z",
"completed_at": "2026-01-31T09:00:00Z",
"consumer_confirmed_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single review by id.
An id for a review you are not assigned to answers 404 rather than 403, so the response never confirms that a review you cannot see exists.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
publicIdpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"will_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"status_label": "string",
"review_type": "string",
"reviewer_role": "string",
"requested_at": "2026-01-31T09:00:00Z",
"assigned_at": "2026-01-31T09:00:00Z",
"started_at": "2026-01-31T09:00:00Z",
"completed_at": "2026-01-31T09:00:00Z",
"consumer_confirmed_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Every will on your dashboard's client wills list, most recently changed first: the wills you drafted for your clients, however they were created (in the app or through this API), and your clients' own wills that you are reviewing.
id is the will's id on this API. partner_will_id is the id creating the will through this API answered with, and null for any other will. source is created for a will you drafted and review for a client's own will under your review.
A will leaves this list when its client withdraws or your review of it ends. The client's withdrawal is reported by /ext/clients/ with updated_since.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"partner_will_id": "string",
"source": "string",
"client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"client_reference": "string",
"document_type": "string",
"will_type": "string",
"jurisdiction": "string",
"state": "string",
"generation_status": "string",
"is_completed": true,
"executed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}Creates a will draft for one of your own active clients and queues its generation. The draft is generated on our own servers. Answers 202 with the new will's id and its status, and a Location header to poll.
will is an object of named sections (jurisdiction and testator are required). Each section is validated with the same rules our own will interface applies, and the whole request is validated before anything is created, so a 400 means nothing was stored. An unknown field is a 400, not silently ignored.
A professional_client_id that is not one of your active clients answers 404.
Every create must carry an Idempotency-Key header, a string of your choosing that is unique to this will; without one the request answers 400. Sending the same key and the same body again within 24 hours returns the will the first request created, with an Idempotent-Replayed: true header, and does not create a second one. Reusing a key with a different body answers 422. A request that was refused (400, 402, 404 or 422) stores nothing, so you can correct it and send it again with the same key.
What it needs
Needs a key with the permission “Create and update wills for your partner clients” (pro:wills:write) and the plan features “API Access” and “Partner Will Creation API”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
Idempotency-Keyheader · string · requiredYour unique key for this will, up to 255 characters. Honoured for 24 hours.
Request body
application/json · requiredprofessional_client_idstring (uuid) · requiredclient_referencestring | nullwillobject · required
{
"professional_client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"client_reference": "string",
"will": {}
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"professional_client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"client_reference": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}status is one of pending, processing, completed, failed or cancelled. A failed generation is reported here, not as an HTTP error; create a new draft to try again.
An id belonging to another professional, or to a client you no longer act for, answers 404.
What it needs
Needs a key with the permission “Create and update wills for your partner clients” (pro:wills:write) and the plan features “API Access” and “Partner Will Creation API”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"professional_client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"client_reference": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Stops a generation that has not finished. Answers 400 when nothing is generating for this will.
What it needs
Needs a key with the permission “Create and update wills for your partner clients” (pro:wills:write) and the plan features “API Access” and “Partner Will Creation API”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"professional_client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"client_reference": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The will document for one will on /ext/wills/, addressed by that list's id. Answers with the file itself (a PDF), exactly when your dashboard would let you download it: a will you are reviewing, or one you drafted once its review is complete. For a will you drafted outside the platform, this is the document you uploaded. Pass variant=signed-scan for the signed copy of an executed will.
Errors:
| Status | When | | --- | --- | | 401 | No Authorization: Bearer twai_… (or legacy pk_…) header, or an unknown key | | 403 | Key lacks the pro:read scope, the plan lacks pro.api_access, or the will's review is not complete | | 404 | The will is not on your list, or has no document yet | | 409 | variant=signed-scan for a will not yet executed | | 429 | Rate limit exceeded |
Every download is recorded. The response carries Cache-Control: no-store: it is a client's personal information.
What it needs
Needs a key with any one of these permissions: “Read every area of your practice” (pro:read) or “Read your clients” (pro:clients:read) and the plan feature “API Access”.
Your professional profile must be in good standing: a struck-off, removed or suspended profile is refused.
Not available to an organisation-wide key; use a personal key.
Parameters
idpath · string · requiredvariantquery · one of: signed-scanOmit for the will document;
signed-scanfor the signed copy of an executed will.
Responses
"string"

