# DealMachine API > Documentation for the DealMachine REST API, CLI, MCP server, and real estate data integrations. Use name enrichment for a specific person. Use People Search for filter-defined audiences. ## Best way to inspect these docs Download all docs as markdown files and grep them locally: ```bash curl -L https://api.docs.dealmachine.com/docs.zip -o docs.zip unzip docs.zip -d docs grep -R "search term" docs/ ``` Use this when you need to search across the whole documentation set. The zip contains every page as a .md file. ## Page index You can also fetch individual markdown pages directly: - [Introduction](https://api.docs.dealmachine.com/introduction.md) - [Authentication](https://api.docs.dealmachine.com/authentication.md) - [Quick Start](https://api.docs.dealmachine.com/quickstart.md) - [Errors](https://api.docs.dealmachine.com/errors.md) - [Rate Limits](https://api.docs.dealmachine.com/rate-limits.md) - [Changelog](https://api.docs.dealmachine.com/changelog.md) - [Searching](https://api.docs.dealmachine.com/concepts/searching.md) - [Locations](https://api.docs.dealmachine.com/concepts/locations.md) - [Filters](https://api.docs.dealmachine.com/concepts/filters.md) - [Filter Values](https://api.docs.dealmachine.com/concepts/filter-values.md) - [Fields](https://api.docs.dealmachine.com/concepts/fields.md) - [Groups](https://api.docs.dealmachine.com/concepts/groups.md) - [Response Format](https://api.docs.dealmachine.com/concepts/response-format.md) - [Pagination & Sorting](https://api.docs.dealmachine.com/concepts/pagination.md) - [Credits](https://api.docs.dealmachine.com/concepts/credits.md) - [Credit-efficient queries](https://api.docs.dealmachine.com/concepts/credit-efficient-queries.md) - [Exporting](https://api.docs.dealmachine.com/concepts/exporting.md) - [Lists](https://api.docs.dealmachine.com/concepts/lists.md) - [Activity History](https://api.docs.dealmachine.com/concepts/activity.md) - [Webhooks](https://api.docs.dealmachine.com/webhooks/introduction.md) - [Events](https://api.docs.dealmachine.com/webhooks/events.md) - [Signatures](https://api.docs.dealmachine.com/webhooks/signatures.md) - [Retries and health](https://api.docs.dealmachine.com/webhooks/retries.md) - [Zapier](https://api.docs.dealmachine.com/webhooks/zapier.md) - [CLI Overview](https://api.docs.dealmachine.com/cli/overview.md) - [Quickstart](https://api.docs.dealmachine.com/cli/quickstart.md) - [Commands](https://api.docs.dealmachine.com/cli/commands.md) - [Authentication](https://api.docs.dealmachine.com/cli/authentication.md) - [Configuration](https://api.docs.dealmachine.com/cli/configuration.md) - [Property Filters](https://api.docs.dealmachine.com/reference/property-filters.md) - [Property Fields](https://api.docs.dealmachine.com/reference/property-fields.md) - [People Filters](https://api.docs.dealmachine.com/reference/people-filters.md) - [People Fields](https://api.docs.dealmachine.com/reference/people-fields.md) - [Introduction](https://api.docs.dealmachine.com/ai-assistants/introduction.md) - [Claude Code](https://api.docs.dealmachine.com/ai-assistants/claude-code.md) - [MCP Server](https://api.docs.dealmachine.com/ai-assistants/mcp-server.md) - [LLM-Readable Docs](https://api.docs.dealmachine.com/ai-assistants/llms-txt.md) - [Introduction](https://api.docs.dealmachine.com/driving/introduction.md) - [List drives](https://api.docs.dealmachine.com/driving/drives/list-drives.md) - [Get drive](https://api.docs.dealmachine.com/driving/drives/get-drive.md) - [Introduction](https://api.docs.dealmachine.com/mail/introduction.md) - [List Campaigns](https://api.docs.dealmachine.com/mail/campaigns/list-campaigns.md) - [Create Campaign](https://api.docs.dealmachine.com/mail/campaigns/create-campaign.md) - [Get Campaign](https://api.docs.dealmachine.com/mail/campaigns/get-campaign.md) - [Update Campaign](https://api.docs.dealmachine.com/mail/campaigns/update-campaign.md) - [Cancel Campaign](https://api.docs.dealmachine.com/mail/campaigns/cancel-campaign.md) - [Launch Campaign](https://api.docs.dealmachine.com/mail/campaigns/send-campaign.md) - [Add Properties to Campaign](https://api.docs.dealmachine.com/mail/campaigns/add-properties.md) - [Estimate Adding Properties](https://api.docs.dealmachine.com/mail/campaigns/estimate-add-properties.md) - [Pause Campaign](https://api.docs.dealmachine.com/mail/campaigns/pause-campaign.md) - [Resume Campaign](https://api.docs.dealmachine.com/mail/campaigns/resume-campaign.md) - [End Campaign](https://api.docs.dealmachine.com/mail/campaigns/end-campaign.md) - [Archive Campaign](https://api.docs.dealmachine.com/mail/campaigns/archive-campaign.md) - [List Recipients](https://api.docs.dealmachine.com/mail/campaigns/list-recipients.md) - [Campaign Analytics](https://api.docs.dealmachine.com/mail/campaigns/campaign-analytics.md) - [Cost Estimate](https://api.docs.dealmachine.com/mail/campaigns/cost-estimate.md) - [List Designs](https://api.docs.dealmachine.com/mail/designs/list-designs.md) - [Create Design](https://api.docs.dealmachine.com/mail/designs/create-design.md) - [Get Design](https://api.docs.dealmachine.com/mail/designs/get-design.md) - [Update Design](https://api.docs.dealmachine.com/mail/designs/update-design.md) - [Delete Design](https://api.docs.dealmachine.com/mail/designs/delete-design.md) - [List Return Addresses](https://api.docs.dealmachine.com/mail/return-addresses/list-return-addresses.md) - [Create Return Address](https://api.docs.dealmachine.com/mail/return-addresses/create-return-address.md) - [Update Return Address](https://api.docs.dealmachine.com/mail/return-addresses/update-return-address.md) - [Set Default Return Address](https://api.docs.dealmachine.com/mail/return-addresses/set-default.md) - [Delete Return Address](https://api.docs.dealmachine.com/mail/return-addresses/delete-return-address.md) - [Get Wallet Balance](https://api.docs.dealmachine.com/mail/wallet/get-balance.md) - [List Transactions](https://api.docs.dealmachine.com/mail/wallet/list-transactions.md) - [Get Pricing](https://api.docs.dealmachine.com/mail/wallet/get-pricing.md) - [Add Funds](https://api.docs.dealmachine.com/mail/wallet/add-funds.md) - [Get Mail Settings](https://api.docs.dealmachine.com/mail/settings/get-settings.md) - [Update Mail Settings](https://api.docs.dealmachine.com/mail/settings/update-settings.md) - [Get Analytics Summary](https://api.docs.dealmachine.com/mail/analytics/get-summary.md) - [Get Analytics Time Series](https://api.docs.dealmachine.com/mail/analytics/get-timeseries.md) - [API Reference](https://api.docs.dealmachine.com/api-reference/introduction.md) - [Request Device Code](https://api.docs.dealmachine.com/api-reference/auth/device-code.md) - [Poll for Device Token](https://api.docs.dealmachine.com/api-reference/auth/device-token.md) - [Authorize](https://api.docs.dealmachine.com/api-reference/oauth/authorize.md) - [Exchange Token](https://api.docs.dealmachine.com/api-reference/oauth/token.md) - [Get User Info](https://api.docs.dealmachine.com/api-reference/oauth/userinfo.md) - [Revoke Token](https://api.docs.dealmachine.com/api-reference/oauth/revoke.md) - [Sign Up](https://api.docs.dealmachine.com/api-reference/account/post-signup.md) - [List Plans](https://api.docs.dealmachine.com/api-reference/account/get-plans.md) - [List Workspace Plans](https://api.docs.dealmachine.com/api-reference/account/get-workspace-plans.md) - [Create Checkout Session](https://api.docs.dealmachine.com/api-reference/account/post-checkout.md) - [Get Account](https://api.docs.dealmachine.com/api-reference/account/get-account.md) - [Get Subscription](https://api.docs.dealmachine.com/api-reference/account/get-subscription.md) - [Get Credit Usage](https://api.docs.dealmachine.com/api-reference/account/get-usage.md) - [List Filters](https://api.docs.dealmachine.com/api-reference/filters/list-filters.md) - [List Fields](https://api.docs.dealmachine.com/api-reference/fields/list-fields.md) - [Get Property](https://api.docs.dealmachine.com/api-reference/properties/get-property.md) - [Get Properties by IDs](https://api.docs.dealmachine.com/api-reference/properties/get-properties.md) - [Search Properties](https://api.docs.dealmachine.com/api-reference/properties/search-properties.md) - [Count Properties](https://api.docs.dealmachine.com/api-reference/properties/count-properties.md) - [Export Properties](https://api.docs.dealmachine.com/api-reference/properties/export-properties.md) - [Get Person](https://api.docs.dealmachine.com/api-reference/people/get-person.md) - [Get People by IDs](https://api.docs.dealmachine.com/api-reference/people/get-people.md) - [Search People](https://api.docs.dealmachine.com/api-reference/people/search-people.md) - [Count People](https://api.docs.dealmachine.com/api-reference/people/count-people.md) - [Export People](https://api.docs.dealmachine.com/api-reference/people/export-people.md) - [List Exports](https://api.docs.dealmachine.com/api-reference/exports/list-exports.md) - [Get Export](https://api.docs.dealmachine.com/api-reference/exports/get-export.md) - [Create List](https://api.docs.dealmachine.com/api-reference/lists/create-list.md) - [List All Lists](https://api.docs.dealmachine.com/api-reference/lists/list-lists.md) - [Get List](https://api.docs.dealmachine.com/api-reference/lists/get-list.md) - [Delete List](https://api.docs.dealmachine.com/api-reference/lists/delete-list.md) - [Add Items to List](https://api.docs.dealmachine.com/api-reference/lists/add-items.md) - [Remove Items from List](https://api.docs.dealmachine.com/api-reference/lists/remove-items.md) - [Export List](https://api.docs.dealmachine.com/api-reference/lists/export-list.md) - [Enrich by Address](https://api.docs.dealmachine.com/api-reference/enrichment/enrich-by-address.md) - [Enrich by Geocode](https://api.docs.dealmachine.com/api-reference/enrichment/enrich-by-reverse-geocode.md) - [Enrich by APN](https://api.docs.dealmachine.com/api-reference/enrichment/enrich-by-apn.md) - [Enrich by Email](https://api.docs.dealmachine.com/api-reference/enrichment/enrich-by-email.md) - [Enrich by Phone](https://api.docs.dealmachine.com/api-reference/enrichment/enrich-by-phone.md) - [Enrich by Name](https://api.docs.dealmachine.com/api-reference/enrichment/enrich-by-name.md) - [Check DNC Status](https://api.docs.dealmachine.com/api-reference/phones/check-dnc.md) - [Search Activity](https://api.docs.dealmachine.com/api-reference/activity/search-activity.md) - [Get Activity](https://api.docs.dealmachine.com/api-reference/activity/get-activity.md) - [Autocomplete Property Addresses](https://api.docs.dealmachine.com/api-reference/addresses/autocomplete-addresses.md) - [Validate Addresses](https://api.docs.dealmachine.com/api-reference/addresses/validate-addresses.md) - [List Locations](https://api.docs.dealmachine.com/api-reference/locations/list-locations.md) - [Get Location](https://api.docs.dealmachine.com/api-reference/locations/get-location.md) - [Prospects](https://api.docs.dealmachine.com/api-reference/prospects/introduction.md) - [Add Prospects](https://api.docs.dealmachine.com/api-reference/prospects/add-prospects.md) - [List Prospects](https://api.docs.dealmachine.com/api-reference/prospects/list-prospects.md) - [Get Prospect](https://api.docs.dealmachine.com/api-reference/prospects/get-prospect.md) - [Get Prospect by Record](https://api.docs.dealmachine.com/api-reference/prospects/get-prospect-by-record.md) - [Update Prospect](https://api.docs.dealmachine.com/api-reference/prospects/update-prospect.md) - [Move Prospects in Bulk](https://api.docs.dealmachine.com/api-reference/prospects/bulk-update-prospects.md) - [Remove Prospect](https://api.docs.dealmachine.com/api-reference/prospects/remove-prospect.md) - [Check Prospects](https://api.docs.dealmachine.com/api-reference/prospects/check-prospects.md) - [Count Prospects](https://api.docs.dealmachine.com/api-reference/prospects/count-prospects.md) - [List Prospect Activity](https://api.docs.dealmachine.com/api-reference/prospects/list-activity.md) - [Prospect Notes](https://api.docs.dealmachine.com/api-reference/prospects/notes.md) - [Prospect Files](https://api.docs.dealmachine.com/api-reference/prospects/files.md) - [Prospect Photos](https://api.docs.dealmachine.com/api-reference/prospects/photos.md) - [Tags on a Prospect](https://api.docs.dealmachine.com/api-reference/prospects/prospect-tags.md) - [Tags](https://api.docs.dealmachine.com/api-reference/tags/introduction.md) - [List Webhooks](https://api.docs.dealmachine.com/api-reference/webhooks/list-webhooks.md) - [Create Webhook](https://api.docs.dealmachine.com/api-reference/webhooks/create-webhook.md) - [Get Webhook](https://api.docs.dealmachine.com/api-reference/webhooks/get-webhook.md) - [Update Webhook](https://api.docs.dealmachine.com/api-reference/webhooks/update-webhook.md) - [Delete Webhook](https://api.docs.dealmachine.com/api-reference/webhooks/delete-webhook.md) - [Test Webhook](https://api.docs.dealmachine.com/api-reference/webhooks/test-webhook.md) - [Rotate Secret](https://api.docs.dealmachine.com/api-reference/webhooks/rotate-secret.md) - [List Deliveries](https://api.docs.dealmachine.com/api-reference/webhooks/list-deliveries.md) - [Redeliver](https://api.docs.dealmachine.com/api-reference/webhooks/redeliver.md) - [List Event Types](https://api.docs.dealmachine.com/api-reference/webhooks/list-events.md) - [List Tasks](https://api.docs.dealmachine.com/tasks/list-tasks.md) - [Create Task](https://api.docs.dealmachine.com/tasks/create-task.md) - [Get Task](https://api.docs.dealmachine.com/tasks/get-task.md) - [Update Task](https://api.docs.dealmachine.com/tasks/update-task.md) - [Delete Task](https://api.docs.dealmachine.com/tasks/delete-task.md) ## Links - [API Reference](/api-reference) - [Support](mailto:support@dealmachine.com) - [Go to App](https://dealmachine.com) - [Get API Key](https://dealmachine.com/settings/developer) - [X](https://twitter.com/deaborobot) - [LinkedIn](https://linkedin.com/company/dealmachine)