API Reference

Deleted Records

Read the records removed from a workspace outright since a point in time, so an integration syncing with `updatedSince` can delete them on its side too.

Last updated 2026-11-18

Overview

GET /partners/deleted-records is the deletion half of incremental sync. List endpoints return records created or changed since `updatedSince`, but a record removed from the database outright no longer exists to be listed — this feed is where its id shows up instead.

Records that are only marked deleted are not here: the list endpoints return them with `includeDeleted=true`, each with `isDeleted: true`. See the Keeping in Sync guide for the full polling loop.

Key concepts

Paging and the next poll

Records come back oldest deletion first. Pass `nextUpdatedSince` back as `updatedSince` while `hasMore` is true; once it is false, store `nextUpdatedSince` and send it on the next poll. Keep this cursor separate from the cursors you store for each list endpoint.

Journal entry lines

Editing a journal entry replaces its lines. The old line ids appear here as `journal_entry`, and the new lines appear on GET /partners/journal-entries with `updatedSince`.

90-day window

Deletions are kept for 90 days. An `updatedSince` older than that returns 410 Gone, because earlier deletions may already be gone from the log: run a full load of each list endpoint again and read deletions from the time you started it.

Deleted record

Attributes

iduuid

The id the record had on its list endpoint. Remove the record with this id from your copy.

resourceTypeenum

What kind of record was removed.

One of: account, bill, budget, customer, customer_address, customer_contact, customer_note, expense_receipt, invoice, journal_entry, person, product, project, recurring_invoice_template, tag, tag_group, task, tax, time_entry, transaction, vendor

deletedAtdatetime

When it was removed (ISO 8601, UTC).

Example
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "resourceType": "tag",
  "deletedAt": "2026-11-18T08:14:02.000Z"
}

Scope and permissions

Needs the `workspace:read` scope. The connecting user needs any one of the view permissions (`view_transactions`, `view_invoices`, `view_bills`, `view_journal_entries`, `view_customers`, `view_vendors`, `view_accounts`, `view_products_services`, `view_projects`, `view_tasks`, `view_people`, `view_receipts`, `view_budgets`). Only resource types the app's grant can read are returned — for example `invoice` rows need `invoices:read`.

MCP equivalent

COUNT_list_deleted_records, with the same parameters under `query`. It is not offered inside COUNT AI chat.

Recent changes

2026-11-18

Incremental sync: updatedSince on every list endpoint, includeDeleted, and the deleted-records feed

Every Partner API list endpoint now takes updatedSince, so an integration can pull only what changed instead of re-reading whole lists. Pass an ISO 8601 date-time and the list returns the records created or changed at or after it, oldest change first, with nextUpdatedSince and hasMore beside the rows; pass nextUpdatedSince back as updatedSince to read the next page, and keep it for the next poll once hasMore is false. Paging by cursor means a record changed mid-walk can no longer move between pages and be skipped, so updatedSince cannot be combined with page above 1 or a sort. includeDeleted=true returns deleted records with isDeleted: true on vendors, customers, products, people, taxes, projects, project tasks, tasks, time entries, recurring invoice templates, the chart of accounts, transactions, invoices, and bills. The chart of accounts returns a flat list of changed accounts in this mode, each naming its parent in parentAccountUuid. Records removed outright — tags, tag groups, journal entry lines, expense receipts, customer contacts, addresses and notes, budgets, and any other hard delete — are listed by the new GET /partners/deleted-records, which keeps 90 days. updatedFrom and updatedTo stay on transactions, invoices, and bills, now read as UTC when they carry no offset. The new Keeping in Sync guide (/guides/keeping-in-sync) puts the pieces together into a 15-minute poll with a sync-now button. The MCP catalog adds COUNT_list_deleted_records, and every list tool takes updatedSince (and includeDeleted where it applies) under query.

Endpoints