Changes
An ordered log of every change to the records, for a sync that misses nothing.
List changes since a checkpoint
Every change to the contacts, leads, deals, tasks, intakes, documents, appointments and communications that the key can read, in the order the changes took effect. BrokerPlus writes each entry in the same database transaction as the change itself, whatever made it: the dashboard, an import, an automation or this API. An entry appears only after its change is committed, and a checkpoint never skips one. Use it as the source of truth for a sync. Webhooks are hints that tell you to call it. Entries are kept for 30 days.
query Parameters
afterThe next_checkpoint from your last call. Omit it to start at the oldest entry kept. Send now to get a checkpoint at the current position and no entries: take it before a full sync from the lists.
typesComma-separated record types to include: contact, lead, deal, task, intake, document, appointment, communication. Default: all of them. A checkpoint is valid with the types it was issued for, or fewer: reading more types from it would skip their entries, so it is refused with 400 INVALID_CHECKPOINT. A checkpoint from after=now belongs to the types sent with it, or to every type when none were sent.
limitMost entries per page, from 1 to 100.
List changes since a checkpoint › Responses
Success
successAlways true on a successful response.
Changes in the order they took effect. A page can hold fewer entries than limit, also none, while has_more is true.
Checkpoint pagination. This envelope replaces the offset pagination of the record lists.