Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Zapier

The DealMachine Zapier app runs on the same API described in these docs. Its triggers are webhooks: when you turn a Zap on, Zapier registers a webhook with consumer: "zapier" for the event types the trigger needs, and removes it when the Zap is turned off. Those webhooks stay out of GET /v1/webhooks unless you pass include_zapier=true, and they do not count toward the 25 webhook limit.

Triggers

TriggerEvent typeOptions
New Prospectprospect.addedRecord type (properties or people), include contact details
Prospect Status Changedprospect.lifecycle_changedNew status (Active, Opportunity, Archived), record type
Prospect Taggedprospect.tags_changed, added tags onlyA specific tag, record type
Note Added to Prospectprospect.note_addedRecord type
Each trigger row is one event: id is the event id, event_type and occurred_at come from the event, and prospect, note, added, and previous_lifecycle match the shapes on the events page. Filters such as the destination status run inside Zapier, so a Zap only uses a task when the filter matches.
Sample data in the Zap editor comes from your newest prospects (GET /v1/prospects), shaped like the live event, so the fields you map while building are the fields the trigger sends.
API clients can receive the same new-prospect event without Zapier. Create a custom webhook with POST /v1/webhooks and include "prospect.added" in event_types.

Actions

ActionEndpoint
Add ProspectPOST /v1/prospects, with POST /v1/enrichment/address first when only a street address is given
Add Note to ProspectPOST /v1/prospects/{id}/notes
Add Tag to ProspectPOST /v1/prospects/{id}/tags/{tag_id}, creating the tag through POST /v1/tags when a new name is typed
Add File to ProspectDownload the mapped file, request POST /v1/prospects/{id}/files/upload-url, upload it, then register it
Change Prospect StatusPATCH /v1/prospects/{id}
Add to ListPOST /v1/lists/{list_id}/items (adds as prospects unless turned off)
Actions that target a prospect accept either a prospect id mapped from a trigger, or a record type and record id, which is resolved through GET /v1/prospects/by-record. Every DealMachine API request carries X-DealMachine-Source: zapier, so prospects first added by a Zap show source: "zapier". Notes, tags, files, and status changes are recorded under the connected DealMachine user.

Prospect lookup

Get Prospect accepts either a Prospect ID and calls GET /v1/prospects/{id}, or a record type and record ID and calls GET /v1/prospects/by-record. It returns the current lifecycle, record summary, tags, and note and file counts without consuming data credits.

Data lookups

The app also exposes property and people search, single-record lookups, enrichment by address, APN, coordinates, email, phone, and name, comps, DNC checks, address validation, and location search. These consume credits the same way the matching API endpoints do; each action says so in its description.
Find Comparable Sales accepts an optional Minimum Year Built and Maximum Year Built. Each boundary is included in the results. Leave both blank for no year filter; either boundary excludes comps with an unknown year built.