Get a record’s history

distru-get-record-historyRead

Shows who changed a record, when, and what they changed.

Inputs

Every tool also takes the common inputs.

FieldTypeRequiredDescription
limitintegerNoDefault: 10
cursorstringNonextCursor of the previous call; keep the other arguments unchanged.
recordTypeenum
43 values
ASSEMBLYAUTOMATIONBATCHBINCHARGE_PRESETCOMPANYCOMPANY_GROUPCOMPLIANCE_TRANSFERCOST_TYPECREDITCUSTOM_VALIDATIONDATASETDRIVERHARVESTINVITATIONINVOICELABEL_TEMPLATEMENUSALES_ORDERPACKAGEPAYMENT_METHODPAYMENT_TERMPLANTPLANT_GROUPPRICE_TIERPRODUCTPRODUCT_CATEGORYPRODUCT_GROUPPURCHASERELATIONSHIP_TYPERETURNROLESCHEDULED_ALERTSTOCK_TRANSFERSTRAINTAGTAXTEAMTEARDOWNTEST_RESULTUNIT_TYPEUSERVEHICLE
Yes
recordIdstringYesThe record's ID, of recordType's kind: from that kind's search tool where one exists (e.g. distru-search-sales-orders, distru-search-products, distru-search-lookups), or a reference's id in another history entry. COMPLIANCE_TRANSFER, CUSTOM_VALIDATION, DATASET, DRIVER, INVITATION, LABEL_TEMPLATE, ROLE, SCHEDULED_ALERT, TEAM and VEHICLE ids come only from references.
sortByobjectNoDefault CHANGED_AT DESC, newest first.
sortBy.directionenum
ASCDESC
Yes
sortBy.fieldenum
CHANGED_AT
YesCHANGED_AT: when the action started, or the note was logged.

Output

Presence on a nested field assumes its parent exists.

FieldTypePresenceDescription
hasMorebooleanAlways
nextCursorstringCan be absent
totalCountintegerCan be absent
items(object or object)[]Always
items[].typeenum
CHANGE
Always
items[].idstringAlways
items[].changedAtstringAlways
items[].actorobjectCan be nullNull for syncs and jobs.
items[].actor.idstringCan be nullNull for Distru Support and another company's user, whose id no tool takes.
items[].actor.namestringAlways
items[].actor.companyNamestringCan be nullThe actor's company, when it isn't the record's (a buyer's user).
items[].impersonatorobjectCan be nullDistru staff acting for the actor, as Distru Support.
items[].impersonator.idstringCan be nullNull for Distru Support and another company's user, whose id no tool takes.
items[].impersonator.namestringAlways
items[].impersonator.companyNamestringCan be nullThe actor's company, when it isn't the record's (a buyer's user).
items[].sourceenum
16 values
AI_AGENTAUTOMATIONBIOTRACKIMPORTJOBLEGACYMCPMETRCMIGRATIONMOBILEPARTNER_APIPUBLIC_APIQUICKBOOKSSTAFF_SQLUNKNOWNWEB
Always
items[].sourceDetailstringCan be nullThe API key or automation name; Distru Support for a fix by Distru staff.
items[].rowCountintegerAlways
items[].truncatedbooleanAlwaysWhether rows holds only the first 50 rows.
items[].rowsobject[]Always
items[].rows[].entityenum
128 values
ACCOUNTASSEMBLYASSEMBLY_INPUTASSEMBLY_OUTPUTASSEMBLY_OUTPUT_BINAUTOMATIONAUTOMATION_VERSIONBATCHBILL_OF_MATERIALSBINCHARGECHARGE_PRESETCHARGE_PRESET_OWNER_TEAMCHARGE_PRESET_OWNER_USERCHARGE_PRESET_TAGCOMPANYCOMPANY_GROUPCOMPANY_SETTINGSCOMPLIANCE_DELIVERYCOMPLIANCE_TRANSFERCONTACTCOST_TYPECREDITCREDIT_USECUSTOM_FIELDCUSTOM_VALIDATIONDATASETDEFAULT_MENU_INTERNAL_ORDER_NOTIFICATIONS_RECIPIENTDRIVERHARVESTHARVEST_GROUPHARVEST_WASTEIMAGEINVITATIONINVOICEINVOICE_ITEMINVOICE_PAYMENTINVOICE_RECIPIENT_EMAILINVOICE_SIGNATURELABEL_TEMPLATELICENSELOCATIONMATERIAL_TEST_RESULTMCP_API_KEYMENUMENU_BANNER_IMAGEMENU_COLLECTIONMENU_COLLECTION_BRANDMENU_COLLECTION_IMAGEMENU_COLLECTION_OFFICIAL_PRODUCT_CATEGORYMENU_COLLECTION_PRODUCT_CATEGORYMENU_COLLECTION_PRODUCT_GROUPMENU_COLLECTION_PRODUCT_SUBCATEGORYMENU_COLLECTION_STRAINMENU_COLLECTION_STRAIN_TYPEMENU_HOLDERMENU_INTERNAL_ORDER_NOTIFICATIONS_RECIPIENTMENU_OFFICIAL_PRODUCT_CATEGORY_TO_SELL_BY_POTENCYMENU_PRICE_TIERMENU_PRODUCTMENU_URLOFFICIAL_PRODUCT_CATEGORYORDER_ITEMORDER_SHIPMENTORDER_SHIPMENT_ITEMORDER_SHIPMENT_SIGNATUREPACKAGEPACKAGE_BINPARTNERPARTNER_CONNECTIONPAYMENTPAYMENT_METHODPAYMENT_TERMPENDING_METRC_ITEMPLANTPLANT_ADDITIVEPLANT_ADDITIVE_TARGETPLANT_ADDITIVE_TYPEPLANT_GROUPPLANT_WASTEPLANT_WASTE_PLANTPRICE_TIERPRODUCTPRODUCT_CATEGORYPRODUCT_GROUPPRODUCT_SUBCATEGORYPRODUCT_TAGPROFILEPUBLIC_API_KEYPURCHASEPURCHASE_PAYMENTQB_ACCOUNTQB_AUTH_TOKENQB_CLASSQB_CUSTOMERQB_VENDORQUICKBOOKS_ITEMQUICKBOOKS_SETTINGSRECURRING_SCHEDULERELATIONSHIP_TYPEREQUESTRETURNRETURN_ITEMROLESALES_ORDERSCHEDULED_ALERTSCHEDULED_QB_EXPORTSCHEDULED_REPORTSIGNATURESTOCK_ADJUSTMENTSTOCK_TRANSFERSTOCK_TRANSFER_ITEMSTRAINTAGTASKTAXTAX_TAGTEAMTEAM_MEMBERSHIPTEARDOWNTEARDOWN_INPUTTEARDOWN_MAPPINGTEARDOWN_OUTPUTTEST_RESULTUNIT_TYPEUSERVEHICLEWEBHOOK_CONFIGURATION
Always
items[].rows[].entityLabelstringAlways
items[].rows[].openum
DELETEINSERTUPDATE
Always
items[].rows[].rowIdstringCan be absentLeft out when the MCP takes that type's ids nowhere; QuickBooks ids are raw.
items[].rows[].rowLabelstringCan be null
items[].rows[].fieldsobject[]Always
items[].rows[].fields[].fieldstringAlways
items[].rows[].fields[].labelstringAlways
items[].rows[].fields[].oldValueanyAlways
items[].rows[].fields[].newValueanyAlways
items[].rows[].fields[].legacyTextobjectCan be absentAn entry copied from the old activity feed: its text, with no values.
items[].rows[].fields[].legacyText.oldstringCan be null
items[].rows[].fields[].legacyText.newstringCan be null
items[].eventsobject[]Always
items[].events[].typeenum
CREDIT_USE_DELETEDCREDIT_USEDLEGACY_NOTEQUICKBOOKS_CUSTOMER_DELETEDQUICKBOOKS_PAYMENT_MERGEDQUICKBOOKS_VENDOR_DELETED
Always
items[].events[].messagestringCan be null
items[].typeenum
NOTE
Always
items[].idstringAlways
items[].changedAtstringAlways
items[].actorobjectCan be nullNull for syncs and jobs.
items[].actor.idstringCan be nullNull for Distru Support and another company's user, whose id no tool takes.
items[].actor.namestringAlways
items[].actor.companyNamestringCan be nullThe actor's company, when it isn't the record's (a buyer's user).
items[].noteTypeenum
EMAILMEETINGNOTEPHONE
Always
items[].textstringCan be null
items[].loggedOnobjectCan be nullThe record the note was logged on, when it is not this one.
items[].loggedOn.typeenum
128 values
ACCOUNTASSEMBLYASSEMBLY_INPUTASSEMBLY_OUTPUTASSEMBLY_OUTPUT_BINAUTOMATIONAUTOMATION_VERSIONBATCHBILL_OF_MATERIALSBINCHARGECHARGE_PRESETCHARGE_PRESET_OWNER_TEAMCHARGE_PRESET_OWNER_USERCHARGE_PRESET_TAGCOMPANYCOMPANY_GROUPCOMPANY_SETTINGSCOMPLIANCE_DELIVERYCOMPLIANCE_TRANSFERCONTACTCOST_TYPECREDITCREDIT_USECUSTOM_FIELDCUSTOM_VALIDATIONDATASETDEFAULT_MENU_INTERNAL_ORDER_NOTIFICATIONS_RECIPIENTDRIVERHARVESTHARVEST_GROUPHARVEST_WASTEIMAGEINVITATIONINVOICEINVOICE_ITEMINVOICE_PAYMENTINVOICE_RECIPIENT_EMAILINVOICE_SIGNATURELABEL_TEMPLATELICENSELOCATIONMATERIAL_TEST_RESULTMCP_API_KEYMENUMENU_BANNER_IMAGEMENU_COLLECTIONMENU_COLLECTION_BRANDMENU_COLLECTION_IMAGEMENU_COLLECTION_OFFICIAL_PRODUCT_CATEGORYMENU_COLLECTION_PRODUCT_CATEGORYMENU_COLLECTION_PRODUCT_GROUPMENU_COLLECTION_PRODUCT_SUBCATEGORYMENU_COLLECTION_STRAINMENU_COLLECTION_STRAIN_TYPEMENU_HOLDERMENU_INTERNAL_ORDER_NOTIFICATIONS_RECIPIENTMENU_OFFICIAL_PRODUCT_CATEGORY_TO_SELL_BY_POTENCYMENU_PRICE_TIERMENU_PRODUCTMENU_URLOFFICIAL_PRODUCT_CATEGORYORDER_ITEMORDER_SHIPMENTORDER_SHIPMENT_ITEMORDER_SHIPMENT_SIGNATUREPACKAGEPACKAGE_BINPARTNERPARTNER_CONNECTIONPAYMENTPAYMENT_METHODPAYMENT_TERMPENDING_METRC_ITEMPLANTPLANT_ADDITIVEPLANT_ADDITIVE_TARGETPLANT_ADDITIVE_TYPEPLANT_GROUPPLANT_WASTEPLANT_WASTE_PLANTPRICE_TIERPRODUCTPRODUCT_CATEGORYPRODUCT_GROUPPRODUCT_SUBCATEGORYPRODUCT_TAGPROFILEPUBLIC_API_KEYPURCHASEPURCHASE_PAYMENTQB_ACCOUNTQB_AUTH_TOKENQB_CLASSQB_CUSTOMERQB_VENDORQUICKBOOKS_ITEMQUICKBOOKS_SETTINGSRECURRING_SCHEDULERELATIONSHIP_TYPEREQUESTRETURNRETURN_ITEMROLESALES_ORDERSCHEDULED_ALERTSCHEDULED_QB_EXPORTSCHEDULED_REPORTSIGNATURESTOCK_ADJUSTMENTSTOCK_TRANSFERSTOCK_TRANSFER_ITEMSTRAINTAGTASKTAXTAX_TAGTEAMTEAM_MEMBERSHIPTEARDOWNTEARDOWN_INPUTTEARDOWN_MAPPINGTEARDOWN_OUTPUTTEST_RESULTUNIT_TYPEUSERVEHICLEWEBHOOK_CONFIGURATION
Can be null
items[].loggedOn.idstringCan be absent
items[].loggedOn.namestringAlways
What the AI reads

A record's history, as on its History tab: who changed it and when, what each field was before and after, and old notes, calls, meetings and emails logged on it. One CHANGE entry per action (a save, import, sync, job or automation run), with the rows of the record and its lines it wrote (the record's own row first; the first 50 when truncated). rowCount counts rows after netting each row's changes in the action, so it can be lower than distru-search-activity's. Values are raw (ids, numbers, enum values). A reference is {id, name}: name is its current name, null once the record is deleted or archived; no id when the MCP takes that type's ids nowhere or it is another company's (a menu buyer's account, user or locations). A field customFields.<id> is that custom field, named in label. A field with legacyText was copied from the old activity feed: its name is that feed's, and legacyText holds its text. An entry shows only this record's part of an action: for everything the action changed, pass its id to distru-search-activity ids. For changes across the company, use distru-search-activity. A page can hold fewer entries than limit, even none, while hasMore is true: keep following nextCursor. Errors as not found when no record of recordType matches recordId (another company's included); a permission error if the caller can't view it, its team restrictions included.