Prospects
Prospects are the records your team has chosen to work: a property you want to buy, an owner you want to reach, a company you are researching. A record becomes a prospect when someone adds it (in the app, from a list, from a drive, or through this API), and it stays a prospect until it is archived.
Every prospect carries a lifecycle (
active, opportunity, or archived), an optional star (favorite), tags from the workspace's tag catalog, and any notes, files, and photos your team attaches. Everything that happens to it lands in its activity feed.IDs
| Kind | Format | Example |
| Prospect | prospect_{id} | prospect_8812 |
| Property record | prop_{id} | prop_12345 |
| Person record | person_{id} | person_67890 |
| Note | note_{id} | note_9 |
| File | file_{id} | file_2 |
| Photo | photo_{id} | photo_44 |
| Tag | tag_{id} | tag_5 |
Bare numbers are accepted anywhere an ID is expected.
Where an add came from
The prospect's
source says how it was added: api for API calls, zapier, cli, or mcp when the request carries X-DealMachine-Source with that value (the DealMachine CLI, MCP server, and Zapier app set it for you). App-owned sources such as driving and mail cannot be set through the API.Adding records to a list through
/v1/lists also tracks them as prospects unless the call passes add_as_prospects: false.Resources
| Endpoint | Description |
| Add prospects | Track one record or up to 1,000 |
| List prospects | Page by lifecycle, source, list, tag, or search |
| Get prospect | One prospect with counts |
| Get prospect by record | Resolve a record to its prospect |
| Update prospect | Lifecycle and favorite |
| Remove prospect | Archive |
| Check prospects | State for up to 500 records |
| Count prospects | Lifecycle by record type |
| Activity | The record's feed |
| Notes | List, add, edit, delete |
| Files | Upload, list, download, delete |
| Photos | List, add, delete (property prospects) |
| Tags on a prospect | Set, add, remove |
| Tag catalog | Create and manage workspace tags |