{"info":{"_postman_id":"d515434d-e391-4b3c-9e68-0e6b583ce703","name":"Senior Living CRM Integration API","description":"<html><head></head><body><h1 id=\"senior-living-crm-integration-api\">Senior Living CRM Integration API</h1>\n<p>This collection sets out the API a senior living CRM needs to provide for a two-way integration with ActiveDEMAND. The CRM builds these endpoints and ActiveDEMAND calls them. The <strong>ActiveDEMAND Contact History</strong> folder at the end covers the other direction: the CRM calling ActiveDEMAND's API for a contact's engagement history.</p>\n<h2 id=\"conventions\">Conventions</h2>\n<p><strong>Base URL.</strong> Every path is relative to the CRM's API base URL (<code>https://crm.example.com/api</code>). Everything except the community list is scoped to one community: <code>/communities/{community_id}/...</code>.</p>\n<p><strong>Format.</strong> All requests and responses are JSON, UTF-8. Send <code>Content-Type: application/json</code> on POST and PUT.</p>\n<p><strong>Timestamps.</strong> ISO 8601 in UTC, for example <code>2026-09-01T13:54:00Z</code>. Plain dates are <code>YYYY-MM-DD</code>.</p>\n<p><strong>Authentication.</strong> Send the CRM API key in the request header:</p>\n<p><code>X-Api-Key: CRM_API_KEY</code></p>\n<h2 id=\"pagination\">Pagination</h2>\n<p>Every endpoint that returns a list takes <code>page</code> (starting at 0) and <code>limit</code> (records per page, max 500) as <strong>query parameters</strong>. When there are more records, the response should include a <code>Link</code> header with <code>rel=\"next\"</code>:</p>\n<p><code>Link: &lt;https://crm.example.com/api/communities/123/prospects?page=1&amp;limit=100&gt;; rel=\"next\"</code></p>\n<h2 id=\"incremental-sync-updated_since\">Incremental sync: <code>updated_since</code></h2>\n<p>List endpoints for contacts, prospects, activities, units, deposits and move-ins take an optional <code>updated_since</code> query parameter. When it is given, only records created or changed after that time are returned. A change to a related record counts: a prospect should come back when one of its resident or influencer contacts changes.</p>\n<p>ActiveDEMAND uses this parameter for its scheduled syncs, so it doesn't have to re-read every record on every run and can catch up on any webhook it missed. Every record should include <code>created_at</code> and <code>updated_at</code>.</p>\n<h2 id=\"updates-put\">Updates (PUT)</h2>\n<p>A PUT updates only the fields in the payload; any field you leave out stays as it is. Sending <code>null</code> clears a field. Array fields (<code>resident_contacts</code>, <code>influencer_contacts</code>) are the exception: the array you send replaces the whole list.</p>\n<h2 id=\"custom-fields\">Custom fields</h2>\n<p>User-defined fields are sent and returned as <code>custom_{id}</code> keys on the record itself, for example <code>\"custom_123\": \"Green Tea\"</code>. Each object's <code>/fields</code> endpoint lists the valid keys, their types and, for list fields, their options.</p>\n<h2 id=\"responses-and-errors\">Responses and errors</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Meaning</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>Success. GET and PUT return the record, POST returns the created record.</td>\n</tr>\n<tr>\n<td>201</td>\n<td>Created (also accepted for POST).</td>\n</tr>\n<tr>\n<td>400</td>\n<td>The request is malformed or a required field is missing.</td>\n</tr>\n<tr>\n<td>401</td>\n<td>The API key is missing or invalid.</td>\n</tr>\n<tr>\n<td>403</td>\n<td>The API key has no access to this community.</td>\n</tr>\n<tr>\n<td>404</td>\n<td>The record or community doesn't exist.</td>\n</tr>\n<tr>\n<td>409</td>\n<td>Conflict, for example a duplicate email address.</td>\n</tr>\n<tr>\n<td>422</td>\n<td>A field value is invalid, for example a stage that isn't in the options.</td>\n</tr>\n<tr>\n<td>429</td>\n<td>Rate limited. Include a <code>Retry-After</code> header.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Error body:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"error_code\": 400,\n  \"error_message\": \"A required field was missing (first_name)\"\n}\n</code></pre>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Senior Living CRM Integration API","slug":"senior-living-crm-integration-api"}],"owner":"13809894","collectionId":"d515434d-e391-4b3c-9e68-0e6b583ce703","publishedId":"2sBYB4MnRW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-30T14:46:33.000Z"},"item":[{"name":"Communities","item":[{"name":"Get all communities","id":"6f469bf3-94ca-4b73-95cf-2da0af32eaa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities?page=0&limit=100","description":"<p>Returns every community the API key can access. <code>timezone</code> is an IANA name; ActiveDEMAND uses it to show activity times in the community's local time.</p>\n","urlObject":{"path":["communities"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"32547e22-ab83-45c1-a736-409c2807b709","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities?page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities"],"query":[{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 123,\n    \"name\": \"Community 1\",\n    \"timezone\": \"America/Chicago\",\n    \"address\": {\n      \"street\": \"100 Main St\",\n      \"city\": \"Springfield\",\n      \"state\": \"IL\",\n      \"postal_code\": \"62701\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"id\": 124,\n    \"name\": \"Community 2\",\n    \"timezone\": \"America/Chicago\",\n    \"address\": {\n      \"street\": \"200 Oak Ave\",\n      \"city\": \"Springfield\",\n      \"state\": \"IL\",\n      \"postal_code\": \"62702\",\n      \"country\": \"US\"\n    }\n  },\n  {\n    \"id\": 125,\n    \"name\": \"Community 3\",\n    \"timezone\": \"America/New_York\",\n    \"address\": {\n      \"street\": \"5 Harbor Rd\",\n      \"city\": \"Portland\",\n      \"state\": \"ME\",\n      \"postal_code\": \"04101\",\n      \"country\": \"US\"\n    }\n  }\n]"}],"_postman_id":"6f469bf3-94ca-4b73-95cf-2da0af32eaa4"}],"id":"addc7052-f19e-495d-b4ab-b78dfdd6e56b","description":"<p>The communities the API key can access. ActiveDEMAND usually maps each community to its own ActiveDEMAND account or sub-account.</p>\n","_postman_id":"addc7052-f19e-495d-b4ab-b78dfdd6e56b"},{"name":"Contacts","item":[{"name":"Get all contacts","id":"561755ad-b31c-47c1-a0ef-dc21ed7d3b90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/contacts?email_address=test@test.com&phone_number=1231231234&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","description":"<p>Lists the community's contacts. Filter by <code>email_address</code> or <code>phone_number</code> to find a match before creating a contact.</p>\n","urlObject":{"path":["communities","123","contacts"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Optional. Exact match on email address.</p>\n","type":"text/plain"},"key":"email_address","value":"test@test.com"},{"description":{"content":"<p>Optional. Match on phone number, digits only.</p>\n","type":"text/plain"},"key":"phone_number","value":"1231231234"},{"description":{"content":"<p>Optional. ISO 8601 timestamp; only records created or changed after this time are returned.</p>\n","type":"text/plain"},"key":"updated_since","value":"2026-09-01T00:00:00Z"},{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"fbb08c11-600f-42b3-aafe-270c6160c30f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities/123/contacts?email_address=test@test.com&phone_number=1231231234&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities","123","contacts"],"query":[{"key":"email_address","value":"test@test.com","description":"Optional. Exact match on email address."},{"key":"phone_number","value":"1231231234","description":"Optional. Match on phone number, digits only."},{"key":"updated_since","value":"2026-09-01T00:00:00Z","description":"Optional. ISO 8601 timestamp; only records created or changed after this time are returned."},{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 123543,\n    \"first_name\": \"Mary\",\n    \"last_name\": \"Jane\",\n    \"email_address\": \"test@test.com\",\n    \"phone_number\": \"1231231234\",\n    \"custom_123\": \"Green Tea\",\n    \"custom_5363\": 123,\n    \"custom_8543\": \"1987-07-24\",\n    \"do_not_contact\": false,\n    \"created_at\": \"2026-08-01T14:02:00Z\",\n    \"updated_at\": \"2026-09-10T09:30:00Z\"\n  },\n  {\n    \"id\": 54322,\n    \"first_name\": \"Bob\",\n    \"last_name\": \"Smith\",\n    \"email_address\": \"bob@test.com\",\n    \"phone_number\": \"9879879876\",\n    \"custom_123\": \"Vanilla\",\n    \"custom_5363\": null,\n    \"custom_8543\": null,\n    \"do_not_contact\": false,\n    \"created_at\": \"2026-08-01T14:05:00Z\",\n    \"updated_at\": \"2026-08-01T14:05:00Z\"\n  }\n]"}],"_postman_id":"561755ad-b31c-47c1-a0ef-dc21ed7d3b90"},{"name":"Get contact count","id":"1ddbb72e-6755-410c-9177-c647b5f06129","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/contacts/count","description":"<p>Returns the total number of contacts in the community. It takes the same filters as Get all contacts.</p>\n","urlObject":{"path":["communities","123","contacts","count"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"efdcba6b-abcb-4c55-bf83-c8e597c519df","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/contacts/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"total\": 53826\n}"}],"_postman_id":"1ddbb72e-6755-410c-9177-c647b5f06129"},{"name":"Get contact fields","id":"0f81814c-3964-4c86-8820-7ae3cd7bacda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/contacts/fields","description":"<p>Lists every contact field, including user-defined custom fields (the <code>custom_{id}</code> keys). Types are <code>string</code>, <code>integer</code>, <code>float</code>, <code>boolean</code>, <code>date</code>, <code>datetime</code> and <code>list</code>; list fields include their <code>options</code>.</p>\n<p>The example shows the structure, not the full list of fields. The last three before <code>do_not_contact</code> are custom fields.</p>\n","urlObject":{"path":["communities","123","contacts","fields"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"2ddc0bc8-f248-4743-ac36-0b91746acb7f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/contacts/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"key\": \"first_name\",\n    \"name\": \"First Name\",\n    \"type\": \"string\",\n    \"required\": true\n  },\n  {\n    \"key\": \"last_name\",\n    \"name\": \"Last Name\",\n    \"type\": \"string\",\n    \"required\": true\n  },\n  {\n    \"key\": \"email_address\",\n    \"name\": \"Email Address\",\n    \"type\": \"string\",\n    \"required\": false\n  },\n  {\n    \"key\": \"phone_number\",\n    \"name\": \"Phone Number\",\n    \"type\": \"string\",\n    \"required\": false\n  },\n  {\n    \"key\": \"custom_123\",\n    \"name\": \"Favorite Ice Cream Flavor\",\n    \"type\": \"list\",\n    \"required\": false,\n    \"options\": [\n      \"Vanilla\",\n      \"Green Tea\",\n      \"Strawberry\"\n    ]\n  },\n  {\n    \"key\": \"custom_5363\",\n    \"name\": \"Height (cm)\",\n    \"type\": \"integer\",\n    \"required\": false\n  },\n  {\n    \"key\": \"custom_8543\",\n    \"name\": \"Anniversary Date\",\n    \"type\": \"date\",\n    \"required\": false\n  },\n  {\n    \"key\": \"do_not_contact\",\n    \"name\": \"Do Not Contact\",\n    \"type\": \"boolean\",\n    \"required\": false\n  }\n]"}],"_postman_id":"0f81814c-3964-4c86-8820-7ae3cd7bacda"},{"name":"Get contact","id":"c0d3ea42-b20b-4bdd-aa5b-5e57c9d96306","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/contacts/123543","description":"<p>Returns one contact.</p>\n","urlObject":{"path":["communities","123","contacts","123543"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"92d32cc2-c788-4619-8395-37c34ad25eed","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/contacts/123543"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 123543,\n  \"first_name\": \"Mary\",\n  \"last_name\": \"Jane\",\n  \"email_address\": \"test@test.com\",\n  \"phone_number\": \"1231231234\",\n  \"custom_123\": \"Green Tea\",\n  \"custom_5363\": 123,\n  \"custom_8543\": \"1987-07-24\",\n  \"do_not_contact\": false,\n  \"created_at\": \"2026-08-01T14:02:00Z\",\n  \"updated_at\": \"2026-09-10T09:30:00Z\"\n}"}],"_postman_id":"c0d3ea42-b20b-4bdd-aa5b-5e57c9d96306"},{"name":"Create contact","id":"e541ee44-f34e-4364-8517-077b5e210d92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"first_name\": \"Mary\",\n  \"last_name\": \"Jane\",\n  \"email_address\": \"test@test.com\",\n  \"phone_number\": \"1231231234\",\n  \"custom_123\": \"Green Tea\",\n  \"custom_5363\": 123,\n  \"custom_8543\": \"1987-07-24\",\n  \"do_not_contact\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/contacts","description":"<p>Creates a contact and returns it with its new <code>id</code>.</p>\n","urlObject":{"path":["communities","123","contacts"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"07a2e624-f332-4144-8244-90222bff39a9","name":"Created","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"first_name\": \"Mary\",\n  \"last_name\": \"Jane\",\n  \"email_address\": \"test@test.com\",\n  \"phone_number\": \"1231231234\",\n  \"custom_123\": \"Green Tea\",\n  \"custom_5363\": 123,\n  \"custom_8543\": \"1987-07-24\",\n  \"do_not_contact\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/contacts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 123543,\n  \"first_name\": \"Mary\",\n  \"last_name\": \"Jane\",\n  \"email_address\": \"test@test.com\",\n  \"phone_number\": \"1231231234\",\n  \"custom_123\": \"Green Tea\",\n  \"custom_5363\": 123,\n  \"custom_8543\": \"1987-07-24\",\n  \"do_not_contact\": false,\n  \"created_at\": \"2026-08-01T14:02:00Z\",\n  \"updated_at\": \"2026-09-10T09:30:00Z\"\n}"}],"_postman_id":"e541ee44-f34e-4364-8517-077b5e210d92"},{"name":"Update contact","id":"73afc095-ea88-4473-8b1e-dfa4e934155b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"phone_number\": \"1231231299\",\n  \"do_not_contact\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/contacts/123543","description":"<p>Updates a contact. Only the fields you send are changed (see <em>Updates (PUT)</em> in the collection overview).</p>\n","urlObject":{"path":["communities","123","contacts","123543"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"2a457bae-ba13-4ef3-ad92-023b6bb3b902","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"phone_number\": \"1231231299\",\n  \"do_not_contact\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/contacts/123543"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 123543,\n  \"first_name\": \"Mary\",\n  \"last_name\": \"Jane\",\n  \"email_address\": \"test@test.com\",\n  \"phone_number\": \"1231231299\",\n  \"custom_123\": \"Green Tea\",\n  \"custom_5363\": 123,\n  \"custom_8543\": \"1987-07-24\",\n  \"do_not_contact\": true,\n  \"created_at\": \"2026-08-01T14:02:00Z\",\n  \"updated_at\": \"2026-09-10T09:30:00Z\"\n}"}],"_postman_id":"73afc095-ea88-4473-8b1e-dfa4e934155b"}],"id":"463dba5f-60a2-440a-ab24-1220cb68b058","description":"<p>A contact is a person: a resident, or an influencer such as a family member. Prospects (next folder) refer to contacts by id.</p>\n","_postman_id":"463dba5f-60a2-440a-ab24-1220cb68b058"},{"name":"Prospects","item":[{"name":"Get all prospects","id":"a1f817e8-b4af-4aad-848f-98c81a859f17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects?stage=Tour&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","description":"<p>Lists the community's prospects, with their resident and influencer contacts expanded in full.</p>\n","urlObject":{"path":["communities","123","prospects"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Optional. Only prospects at this stage.</p>\n","type":"text/plain"},"key":"stage","value":"Tour"},{"description":{"content":"<p>Optional. ISO 8601 timestamp; only records created or changed after this time are returned.</p>\n","type":"text/plain"},"key":"updated_since","value":"2026-09-01T00:00:00Z"},{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"5a9bf02b-8184-41e2-9283-0dc6a13ce4f9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities/123/prospects?stage=Tour&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities","123","prospects"],"query":[{"key":"stage","value":"Tour","description":"Optional. Only prospects at this stage."},{"key":"updated_since","value":"2026-09-01T00:00:00Z","description":"Optional. ISO 8601 timestamp; only records created or changed after this time are returned."},{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 123455,\n    \"stage\": \"Planning\",\n    \"display_name\": \"Mary & Bob\",\n    \"move_in_value\": 100.0,\n    \"sales_counselor_id\": 4321,\n    \"lead_source_id\": 10,\n    \"referral_source\": \"Website\",\n    \"lost_reason_id\": null,\n    \"care_type_id\": 2,\n    \"resident_contacts\": [\n      {\n        \"id\": 123543,\n        \"first_name\": \"Mary\",\n        \"last_name\": \"Jane\",\n        \"email_address\": \"test@test.com\",\n        \"phone_number\": \"1231231234\",\n        \"custom_123\": \"Green Tea\",\n        \"custom_5363\": 123,\n        \"custom_8543\": \"1987-07-24\",\n        \"do_not_contact\": false,\n        \"created_at\": \"2026-08-01T14:02:00Z\",\n        \"updated_at\": \"2026-09-10T09:30:00Z\"\n      },\n      {\n        \"id\": 54322,\n        \"first_name\": \"Bob\",\n        \"last_name\": \"Smith\",\n        \"email_address\": \"bob@test.com\",\n        \"phone_number\": \"9879879876\",\n        \"custom_123\": \"Vanilla\",\n        \"custom_5363\": null,\n        \"custom_8543\": null,\n        \"do_not_contact\": false,\n        \"created_at\": \"2026-08-01T14:05:00Z\",\n        \"updated_at\": \"2026-08-01T14:05:00Z\"\n      }\n    ],\n    \"influencer_contacts\": [\n      {\n        \"id\": 123543,\n        \"first_name\": \"Mary\",\n        \"last_name\": \"Jane\",\n        \"email_address\": \"test@test.com\",\n        \"phone_number\": \"1231231234\",\n        \"custom_123\": \"Green Tea\",\n        \"custom_5363\": 123,\n        \"custom_8543\": \"1987-07-24\",\n        \"do_not_contact\": false,\n        \"created_at\": \"2026-08-01T14:02:00Z\",\n        \"updated_at\": \"2026-09-10T09:30:00Z\",\n        \"relationship_id\": 3,\n        \"relationship\": \"Spouse\"\n      }\n    ],\n    \"custom_876\": \"Strawberry\",\n    \"created_at\": \"2026-08-01T14:06:00Z\",\n    \"updated_at\": \"2026-09-10T09:30:00Z\"\n  },\n  {\n    \"id\": 123456,\n    \"stage\": \"Tour\",\n    \"display_name\": \"Joe\",\n    \"move_in_value\": 100.0,\n    \"sales_counselor_id\": 4321,\n    \"lead_source_id\": 11,\n    \"referral_source\": \"A Place for Mom\",\n    \"lost_reason_id\": null,\n    \"care_type_id\": 1,\n    \"resident_contacts\": [\n      {\n        \"id\": 54323,\n        \"first_name\": \"Joe\",\n        \"last_name\": \"Smith\",\n        \"email_address\": \"joe@test.com\",\n        \"phone_number\": \"9879879877\",\n        \"custom_123\": \"Vanilla\",\n        \"custom_5363\": null,\n        \"custom_8543\": null,\n        \"do_not_contact\": false,\n        \"created_at\": \"2026-08-12T10:00:00Z\",\n        \"updated_at\": \"2026-08-12T10:00:00Z\"\n      }\n    ],\n    \"influencer_contacts\": [],\n    \"custom_876\": \"Strawberry\",\n    \"created_at\": \"2026-08-12T10:01:00Z\",\n    \"updated_at\": \"2026-09-02T16:20:00Z\"\n  }\n]"}],"_postman_id":"a1f817e8-b4af-4aad-848f-98c81a859f17"},{"name":"Get prospect count","id":"1b53f675-b659-43aa-a900-9da6392966df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects/count","description":"<p>Returns the total number of prospects in the community. It takes the same filters as Get all prospects.</p>\n","urlObject":{"path":["communities","123","prospects","count"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"71f25ade-cd0e-472b-a1cf-01fa38b624ba","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"total\": 53826\n}"}],"_postman_id":"1b53f675-b659-43aa-a900-9da6392966df"},{"name":"Get prospect fields","id":"0631856d-94f1-47f5-b9d1-250ae39cac8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects/fields","description":"<p>Lists every prospect field, including custom fields. The options on <code>stage</code> are the community's sales stages, in pipeline order.</p>\n","urlObject":{"path":["communities","123","prospects","fields"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"d6d69fd8-2390-49f2-8996-b04c40e2fbd6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"key\": \"stage\",\n    \"name\": \"Stage\",\n    \"type\": \"list\",\n    \"required\": true,\n    \"options\": [\n      \"Planning\",\n      \"Tour\",\n      \"Deposit\",\n      \"Moved-In\",\n      \"Lost\"\n    ]\n  },\n  {\n    \"key\": \"display_name\",\n    \"name\": \"Display Name\",\n    \"type\": \"string\",\n    \"required\": false\n  },\n  {\n    \"key\": \"move_in_value\",\n    \"name\": \"Move In Value\",\n    \"type\": \"float\",\n    \"required\": false\n  },\n  {\n    \"key\": \"sales_counselor_id\",\n    \"name\": \"Sales Counselor\",\n    \"type\": \"integer\",\n    \"required\": false\n  },\n  {\n    \"key\": \"lead_source_id\",\n    \"name\": \"Lead Source\",\n    \"type\": \"integer\",\n    \"required\": false\n  },\n  {\n    \"key\": \"referral_source\",\n    \"name\": \"Referral Source\",\n    \"type\": \"string\",\n    \"required\": false\n  },\n  {\n    \"key\": \"lost_reason_id\",\n    \"name\": \"Lost Reason\",\n    \"type\": \"integer\",\n    \"required\": false\n  },\n  {\n    \"key\": \"care_type_id\",\n    \"name\": \"Care Type\",\n    \"type\": \"integer\",\n    \"required\": false\n  },\n  {\n    \"key\": \"resident_contacts\",\n    \"name\": \"Residents\",\n    \"type\": \"list\",\n    \"required\": false\n  },\n  {\n    \"key\": \"influencer_contacts\",\n    \"name\": \"Influencers\",\n    \"type\": \"list\",\n    \"required\": false\n  },\n  {\n    \"key\": \"custom_876\",\n    \"name\": \"Favorite Ice Cream Flavor\",\n    \"type\": \"list\",\n    \"required\": false,\n    \"options\": [\n      \"Vanilla\",\n      \"Green Tea\",\n      \"Strawberry\"\n    ]\n  }\n]"}],"_postman_id":"0631856d-94f1-47f5-b9d1-250ae39cac8f"},{"name":"Get prospect","id":"edfbafff-8783-40ff-bc29-bc8cbc4d63a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects/123455","description":"<p>Returns one prospect.</p>\n","urlObject":{"path":["communities","123","prospects","123455"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"914678f1-f126-4c44-9909-ac5191c1d0f7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects/123455"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 123455,\n  \"stage\": \"Planning\",\n  \"display_name\": \"Mary & Bob\",\n  \"move_in_value\": 100.0,\n  \"sales_counselor_id\": 4321,\n  \"lead_source_id\": 10,\n  \"referral_source\": \"Website\",\n  \"lost_reason_id\": null,\n  \"care_type_id\": 2,\n  \"resident_contacts\": [\n    {\n      \"id\": 123543,\n      \"first_name\": \"Mary\",\n      \"last_name\": \"Jane\",\n      \"email_address\": \"test@test.com\",\n      \"phone_number\": \"1231231234\",\n      \"custom_123\": \"Green Tea\",\n      \"custom_5363\": 123,\n      \"custom_8543\": \"1987-07-24\",\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:02:00Z\",\n      \"updated_at\": \"2026-09-10T09:30:00Z\"\n    },\n    {\n      \"id\": 54322,\n      \"first_name\": \"Bob\",\n      \"last_name\": \"Smith\",\n      \"email_address\": \"bob@test.com\",\n      \"phone_number\": \"9879879876\",\n      \"custom_123\": \"Vanilla\",\n      \"custom_5363\": null,\n      \"custom_8543\": null,\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:05:00Z\",\n      \"updated_at\": \"2026-08-01T14:05:00Z\"\n    }\n  ],\n  \"influencer_contacts\": [\n    {\n      \"id\": 123543,\n      \"first_name\": \"Mary\",\n      \"last_name\": \"Jane\",\n      \"email_address\": \"test@test.com\",\n      \"phone_number\": \"1231231234\",\n      \"custom_123\": \"Green Tea\",\n      \"custom_5363\": 123,\n      \"custom_8543\": \"1987-07-24\",\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:02:00Z\",\n      \"updated_at\": \"2026-09-10T09:30:00Z\",\n      \"relationship_id\": 3,\n      \"relationship\": \"Spouse\"\n    }\n  ],\n  \"custom_876\": \"Strawberry\",\n  \"created_at\": \"2026-08-01T14:06:00Z\",\n  \"updated_at\": \"2026-09-10T09:30:00Z\"\n}"}],"_postman_id":"edfbafff-8783-40ff-bc29-bc8cbc4d63a7"},{"name":"Get deleted prospects","id":"e2b8c42a-873b-4ce3-b005-8e8187e26675","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/prospects/deleted?since=2026-09-01T00:00:00Z&page=0&limit=100","description":"<p>Lists prospects deleted or merged since the given time. For a merge, <code>merged_into_id</code> is the prospect that survived. ActiveDEMAND needs this so it stops marketing to records that no longer exist.</p>\n","urlObject":{"path":["communities","123","prospects","deleted"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Required. ISO 8601 timestamp.</p>\n","type":"text/plain"},"key":"since","value":"2026-09-01T00:00:00Z"},{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"3a789620-40e5-42d5-838a-642bff613490","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities/123/prospects/deleted?since=2026-09-01T00:00:00Z&page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities","123","prospects","deleted"],"query":[{"key":"since","value":"2026-09-01T00:00:00Z","description":"Required. ISO 8601 timestamp."},{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 54399,\n    \"deleted_at\": \"2026-09-14T11:02:00Z\",\n    \"merged_into_id\": null\n  },\n  {\n    \"id\": 61001,\n    \"deleted_at\": \"2026-09-15T16:40:00Z\",\n    \"merged_into_id\": 123455\n  }\n]"}],"_postman_id":"e2b8c42a-873b-4ce3-b005-8e8187e26675"},{"name":"Create prospect","id":"e4e81366-b977-417a-8037-bea1db6a3fe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"stage\": \"Planning\",\n  \"display_name\": \"Mary & Bob\",\n  \"move_in_value\": 100.0,\n  \"sales_counselor_id\": 4321,\n  \"lead_source_id\": 10,\n  \"referral_source\": \"Website\",\n  \"care_type_id\": 2,\n  \"resident_contacts\": [\n    {\n      \"id\": 123543\n    },\n    {\n      \"id\": 54322\n    }\n  ],\n  \"influencer_contacts\": [\n    {\n      \"id\": 123543,\n      \"relationship_id\": 3\n    }\n  ],\n  \"custom_876\": \"Strawberry\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/prospects","description":"<p>Creates a prospect. Create the contacts first, then send their ids in <code>resident_contacts</code> and <code>influencer_contacts</code>. Returns the prospect with its contacts expanded.</p>\n","urlObject":{"path":["communities","123","prospects"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"c8dd136e-ded0-4d1a-b693-35750010c547","name":"Created","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"stage\": \"Planning\",\n  \"display_name\": \"Mary & Bob\",\n  \"move_in_value\": 100.0,\n  \"sales_counselor_id\": 4321,\n  \"lead_source_id\": 10,\n  \"referral_source\": \"Website\",\n  \"care_type_id\": 2,\n  \"resident_contacts\": [\n    {\n      \"id\": 123543\n    },\n    {\n      \"id\": 54322\n    }\n  ],\n  \"influencer_contacts\": [\n    {\n      \"id\": 123543,\n      \"relationship_id\": 3\n    }\n  ],\n  \"custom_876\": \"Strawberry\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/prospects"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 123455,\n  \"stage\": \"Planning\",\n  \"display_name\": \"Mary & Bob\",\n  \"move_in_value\": 100.0,\n  \"sales_counselor_id\": 4321,\n  \"lead_source_id\": 10,\n  \"referral_source\": \"Website\",\n  \"lost_reason_id\": null,\n  \"care_type_id\": 2,\n  \"resident_contacts\": [\n    {\n      \"id\": 123543,\n      \"first_name\": \"Mary\",\n      \"last_name\": \"Jane\",\n      \"email_address\": \"test@test.com\",\n      \"phone_number\": \"1231231234\",\n      \"custom_123\": \"Green Tea\",\n      \"custom_5363\": 123,\n      \"custom_8543\": \"1987-07-24\",\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:02:00Z\",\n      \"updated_at\": \"2026-09-10T09:30:00Z\"\n    },\n    {\n      \"id\": 54322,\n      \"first_name\": \"Bob\",\n      \"last_name\": \"Smith\",\n      \"email_address\": \"bob@test.com\",\n      \"phone_number\": \"9879879876\",\n      \"custom_123\": \"Vanilla\",\n      \"custom_5363\": null,\n      \"custom_8543\": null,\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:05:00Z\",\n      \"updated_at\": \"2026-08-01T14:05:00Z\"\n    }\n  ],\n  \"influencer_contacts\": [\n    {\n      \"id\": 123543,\n      \"first_name\": \"Mary\",\n      \"last_name\": \"Jane\",\n      \"email_address\": \"test@test.com\",\n      \"phone_number\": \"1231231234\",\n      \"custom_123\": \"Green Tea\",\n      \"custom_5363\": 123,\n      \"custom_8543\": \"1987-07-24\",\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:02:00Z\",\n      \"updated_at\": \"2026-09-10T09:30:00Z\",\n      \"relationship_id\": 3,\n      \"relationship\": \"Spouse\"\n    }\n  ],\n  \"custom_876\": \"Strawberry\",\n  \"created_at\": \"2026-08-01T14:06:00Z\",\n  \"updated_at\": \"2026-09-10T09:30:00Z\"\n}"}],"_postman_id":"e4e81366-b977-417a-8037-bea1db6a3fe3"},{"name":"Update prospect","id":"b55dce86-a65b-4196-9fff-a22f5d32cadd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"stage\": \"Moved-In\",\n  \"move_in_value\": 5200.0\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/prospects/123455","description":"<p>Updates a prospect. Only the fields you send are changed. <code>resident_contacts</code> and <code>influencer_contacts</code>, if sent, replace the whole list.</p>\n","urlObject":{"path":["communities","123","prospects","123455"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"c8a0cd7c-a6ad-453e-8550-4884cc278060","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"stage\": \"Moved-In\",\n  \"move_in_value\": 5200.0\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/prospects/123455"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 123455,\n  \"stage\": \"Moved-In\",\n  \"display_name\": \"Mary & Bob\",\n  \"move_in_value\": 5200.0,\n  \"sales_counselor_id\": 4321,\n  \"lead_source_id\": 10,\n  \"referral_source\": \"Website\",\n  \"lost_reason_id\": null,\n  \"care_type_id\": 2,\n  \"resident_contacts\": [\n    {\n      \"id\": 123543,\n      \"first_name\": \"Mary\",\n      \"last_name\": \"Jane\",\n      \"email_address\": \"test@test.com\",\n      \"phone_number\": \"1231231234\",\n      \"custom_123\": \"Green Tea\",\n      \"custom_5363\": 123,\n      \"custom_8543\": \"1987-07-24\",\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:02:00Z\",\n      \"updated_at\": \"2026-09-10T09:30:00Z\"\n    },\n    {\n      \"id\": 54322,\n      \"first_name\": \"Bob\",\n      \"last_name\": \"Smith\",\n      \"email_address\": \"bob@test.com\",\n      \"phone_number\": \"9879879876\",\n      \"custom_123\": \"Vanilla\",\n      \"custom_5363\": null,\n      \"custom_8543\": null,\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:05:00Z\",\n      \"updated_at\": \"2026-08-01T14:05:00Z\"\n    }\n  ],\n  \"influencer_contacts\": [\n    {\n      \"id\": 123543,\n      \"first_name\": \"Mary\",\n      \"last_name\": \"Jane\",\n      \"email_address\": \"test@test.com\",\n      \"phone_number\": \"1231231234\",\n      \"custom_123\": \"Green Tea\",\n      \"custom_5363\": 123,\n      \"custom_8543\": \"1987-07-24\",\n      \"do_not_contact\": false,\n      \"created_at\": \"2026-08-01T14:02:00Z\",\n      \"updated_at\": \"2026-09-10T09:30:00Z\",\n      \"relationship_id\": 3,\n      \"relationship\": \"Spouse\"\n    }\n  ],\n  \"custom_876\": \"Strawberry\",\n  \"created_at\": \"2026-08-01T14:06:00Z\",\n  \"updated_at\": \"2026-09-10T09:30:00Z\"\n}"}],"_postman_id":"b55dce86-a65b-4196-9fff-a22f5d32cadd"}],"id":"8060bb8b-31ed-4f1a-b9f6-b459c0f8f4c3","description":"<p>A prospect is a sales opportunity for moving one or more residents into the community. It links resident contacts, influencer contacts, a stage and a sales counselor.</p>\n","_postman_id":"8060bb8b-31ed-4f1a-b9f6-b459c0f8f4c3"},{"name":"Activities","item":[{"name":"Get all activities","id":"d225e2f0-e66f-4674-9943-b40f96d76c17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/activities?prospect_id=123455&status=scheduled&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","description":"<p>Lists the community's activities.</p>\n","urlObject":{"path":["communities","123","activities"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Optional. Only this prospect's activities.</p>\n","type":"text/plain"},"key":"prospect_id","value":"123455"},{"description":{"content":"<p>Optional. scheduled, completed or cancelled.</p>\n","type":"text/plain"},"key":"status","value":"scheduled"},{"description":{"content":"<p>Optional. ISO 8601 timestamp; only records created or changed after this time are returned.</p>\n","type":"text/plain"},"key":"updated_since","value":"2026-09-01T00:00:00Z"},{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"c91b5607-bb1b-401d-9065-41306d959246","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities/123/activities?prospect_id=123455&status=scheduled&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities","123","activities"],"query":[{"key":"prospect_id","value":"123455","description":"Optional. Only this prospect's activities."},{"key":"status","value":"scheduled","description":"Optional. scheduled, completed or cancelled."},{"key":"updated_since","value":"2026-09-01T00:00:00Z","description":"Optional. ISO 8601 timestamp; only records created or changed after this time are returned."},{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 4321,\n    \"activity_type_id\": 12,\n    \"activity_type\": \"Tour\",\n    \"status\": \"completed\",\n    \"due_date\": \"2026-09-01T13:00:00Z\",\n    \"completed_at\": \"2026-09-01T13:54:00Z\",\n    \"outcome_id\": 1,\n    \"outcome\": \"Interested\",\n    \"sales_counselor_id\": 4321,\n    \"notes\": \"Toured the one bedroom floor plan\",\n    \"prospect_id\": 123455,\n    \"created_at\": \"2026-08-28T09:12:00Z\",\n    \"updated_at\": \"2026-09-01T13:55:00Z\"\n  },\n  {\n    \"id\": 4322,\n    \"activity_type_id\": 3,\n    \"activity_type\": \"Call Out\",\n    \"status\": \"scheduled\",\n    \"due_date\": \"2026-09-08T10:00:00Z\",\n    \"completed_at\": null,\n    \"outcome_id\": null,\n    \"outcome\": null,\n    \"sales_counselor_id\": 4321,\n    \"notes\": \"Follow up after tour\",\n    \"prospect_id\": 123455,\n    \"created_at\": \"2026-09-01T13:56:00Z\",\n    \"updated_at\": \"2026-09-01T13:56:00Z\"\n  }\n]"}],"_postman_id":"d225e2f0-e66f-4674-9943-b40f96d76c17"},{"name":"Get activity","id":"913a7b66-9638-4475-a3bf-fd59914589a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/activities/4321","description":"<p>Returns one activity.</p>\n","urlObject":{"path":["communities","123","activities","4321"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"67d0255c-35a9-4984-ae68-35c91e4cc908","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/activities/4321"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 4321,\n  \"activity_type_id\": 12,\n  \"activity_type\": \"Tour\",\n  \"status\": \"completed\",\n  \"due_date\": \"2026-09-01T13:00:00Z\",\n  \"completed_at\": \"2026-09-01T13:54:00Z\",\n  \"outcome_id\": 1,\n  \"outcome\": \"Interested\",\n  \"sales_counselor_id\": 4321,\n  \"notes\": \"Toured the one bedroom floor plan\",\n  \"prospect_id\": 123455,\n  \"created_at\": \"2026-08-28T09:12:00Z\",\n  \"updated_at\": \"2026-09-01T13:55:00Z\"\n}"}],"_postman_id":"913a7b66-9638-4475-a3bf-fd59914589a1"},{"name":"Create activity","id":"a122d1e4-4d89-4aff-b373-c8ae0ef5aec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"activity_type_id\": 12,\n  \"status\": \"scheduled\",\n  \"due_date\": \"2026-09-05T10:00:00Z\",\n  \"sales_counselor_id\": 4321,\n  \"notes\": \"Tour booked from the website form\",\n  \"prospect_id\": 123455\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/activities","description":"<p>Creates an activity on a prospect. Send <code>status: scheduled</code> with a <code>due_date</code> for a future task, or <code>status: completed</code> with a <code>completed_at</code> for something that has already happened.</p>\n","urlObject":{"path":["communities","123","activities"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"d4f514f9-a616-4ba8-b242-d4b892da8021","name":"Created","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"activity_type_id\": 12,\n  \"status\": \"scheduled\",\n  \"due_date\": \"2026-09-05T10:00:00Z\",\n  \"sales_counselor_id\": 4321,\n  \"notes\": \"Tour booked from the website form\",\n  \"prospect_id\": 123455\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/activities"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 4330,\n  \"activity_type_id\": 12,\n  \"activity_type\": \"Tour\",\n  \"status\": \"scheduled\",\n  \"due_date\": \"2026-09-05T10:00:00Z\",\n  \"completed_at\": null,\n  \"outcome_id\": null,\n  \"outcome\": null,\n  \"sales_counselor_id\": 4321,\n  \"notes\": \"Tour booked from the website form\",\n  \"prospect_id\": 123455,\n  \"created_at\": \"2026-09-02T15:00:00Z\",\n  \"updated_at\": \"2026-09-02T15:00:00Z\"\n}"}],"_postman_id":"a122d1e4-4d89-4aff-b373-c8ae0ef5aec2"},{"name":"Update activity","id":"6b98afa4-7c90-4587-a7dc-8980affe0979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"status\": \"completed\",\n  \"completed_at\": \"2026-09-08T10:20:00Z\",\n  \"outcome_id\": 2,\n  \"notes\": \"No answer, left voicemail\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/activities/4321","description":"<p>Updates an activity: to reschedule it, change <code>due_date</code>; to complete it, send <code>status: completed</code> with <code>completed_at</code> and an outcome. Only the fields you send are changed.</p>\n","urlObject":{"path":["communities","123","activities","4321"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"d390dcf4-1c0f-470e-a9c5-6f24301691f1","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"status\": \"completed\",\n  \"completed_at\": \"2026-09-08T10:20:00Z\",\n  \"outcome_id\": 2,\n  \"notes\": \"No answer, left voicemail\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/activities/4321"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 4322,\n  \"activity_type_id\": 3,\n  \"activity_type\": \"Call Out\",\n  \"status\": \"completed\",\n  \"due_date\": \"2026-09-08T10:00:00Z\",\n  \"completed_at\": \"2026-09-08T10:20:00Z\",\n  \"outcome_id\": 2,\n  \"outcome\": \"Left Voicemail\",\n  \"sales_counselor_id\": 4321,\n  \"notes\": \"No answer, left voicemail\",\n  \"prospect_id\": 123455,\n  \"created_at\": \"2026-09-01T13:56:00Z\",\n  \"updated_at\": \"2026-09-08T10:21:00Z\"\n}"}],"_postman_id":"6b98afa4-7c90-4587-a7dc-8980affe0979"},{"name":"Get activity types","id":"acb26e42-aaa2-40ae-bd76-3df8da37b832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/activity_types","description":"<p>Lists the community's activity types. ActiveDEMAND maps each one to one of its own task types, so inactive types should still be returned, flagged <code>active: false</code>.</p>\n","urlObject":{"path":["communities","123","activity_types"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"3f83d3fd-cf24-4cb4-b885-c4c9b32ec1f6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/activity_types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 3,\n    \"name\": \"Call Out\",\n    \"active\": true\n  },\n  {\n    \"id\": 7,\n    \"name\": \"Email Out\",\n    \"active\": true\n  },\n  {\n    \"id\": 12,\n    \"name\": \"Tour\",\n    \"active\": true\n  },\n  {\n    \"id\": 15,\n    \"name\": \"Home Visit\",\n    \"active\": false\n  }\n]"}],"_postman_id":"acb26e42-aaa2-40ae-bd76-3df8da37b832"},{"name":"Get activity outcomes","id":"f9cdaf83-0d23-4dd4-a626-da1d6a9e890f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/activity_outcomes","description":"<p>Lists the outcomes a completed activity can have.</p>\n","urlObject":{"path":["communities","123","activity_outcomes"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"2b535d6a-e293-450a-9956-d6b55c65ad67","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/activity_outcomes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 1,\n    \"name\": \"Interested\"\n  },\n  {\n    \"id\": 2,\n    \"name\": \"Left Voicemail\"\n  },\n  {\n    \"id\": 3,\n    \"name\": \"No Answer\"\n  }\n]"}],"_postman_id":"f9cdaf83-0d23-4dd4-a626-da1d6a9e890f"}],"id":"2b22d0cd-aff4-4867-a216-687235275ccf","description":"<p>Activities are the sales team's calls, tours, appointments and so on for a prospect. ActiveDEMAND reads them to create tasks for the sales team, and writes them to record what it did, such as an automated email or a booked tour.</p>\n<p><code>status</code> is one of <code>scheduled</code>, <code>completed</code> or <code>cancelled</code>. A scheduled activity is a future task, with a <code>due_date</code> and no <code>completed_at</code>.</p>\n","_postman_id":"2b22d0cd-aff4-4867-a216-687235275ccf"},{"name":"Notes","item":[{"name":"Create note on a prospect","id":"9e3310e3-4d6a-4b72-ad20-c301869da3fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"note\": \"Visited the Memory Care pricing page 3 times this week\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/prospects/123455/notes","description":"<p>Adds a note to a prospect.</p>\n","urlObject":{"path":["communities","123","prospects","123455","notes"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"5adc28a3-176c-43eb-837f-3fae210e4558","name":"Created","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"note\": \"Visited the Memory Care pricing page 3 times this week\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/prospects/123455/notes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 3301,\n  \"prospect_id\": 123455,\n  \"note\": \"Visited the Memory Care pricing page 3 times this week\",\n  \"created_at\": \"2026-09-14T11:02:00Z\"\n}"}],"_postman_id":"9e3310e3-4d6a-4b72-ad20-c301869da3fb"}],"id":"4545dc9b-4500-4356-8554-690c4bd98b1d","description":"<p>Optional. Lets ActiveDEMAND add a note to a prospect, such as a summary of the prospect's web and email engagement, without creating an activity.</p>\n","_postman_id":"4545dc9b-4500-4356-8554-690c4bd98b1d"},{"name":"Units","item":[{"name":"Get all units","id":"8921896a-6080-4e75-aaad-d171a48baec0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/units?status=available&care_type_id=2&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","description":"<p>Lists the community's units, with current pricing and availability.</p>\n","urlObject":{"path":["communities","123","units"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Optional. Only units with this status.</p>\n","type":"text/plain"},"key":"status","value":"available"},{"description":{"content":"<p>Optional. Only units of this care type.</p>\n","type":"text/plain"},"key":"care_type_id","value":"2"},{"description":{"content":"<p>Optional. ISO 8601 timestamp; only records created or changed after this time are returned.</p>\n","type":"text/plain"},"key":"updated_since","value":"2026-09-01T00:00:00Z"},{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"5022c9c7-7df8-47f7-9cbd-c6723bf4b671","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities/123/units?status=available&care_type_id=2&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities","123","units"],"query":[{"key":"status","value":"available","description":"Optional. Only units with this status."},{"key":"care_type_id","value":"2","description":"Optional. Only units of this care type."},{"key":"updated_since","value":"2026-09-01T00:00:00Z","description":"Optional. ISO 8601 timestamp; only records created or changed after this time are returned."},{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 9001,\n    \"unit_number\": \"204\",\n    \"floor\": 2,\n    \"floor_plan_id\": 55,\n    \"care_type_id\": 2,\n    \"square_feet\": 780,\n    \"market_rate\": 5200.0,\n    \"floor_price\": 4800.0,\n    \"ceiling_price\": 5600.0,\n    \"amenities\": [\n      \"Balcony\",\n      \"Walk-in shower\"\n    ],\n    \"description\": \"Corner unit overlooking the garden\",\n    \"status\": \"available\",\n    \"available_date\": \"2026-10-15\",\n    \"created_at\": \"2024-01-10T00:00:00Z\",\n    \"updated_at\": \"2026-09-20T08:00:00Z\"\n  },\n  {\n    \"id\": 9002,\n    \"unit_number\": \"205\",\n    \"floor\": 2,\n    \"floor_plan_id\": 54,\n    \"care_type_id\": 1,\n    \"square_feet\": 560,\n    \"market_rate\": 4300.0,\n    \"floor_price\": null,\n    \"ceiling_price\": null,\n    \"amenities\": [],\n    \"description\": \"\",\n    \"status\": \"occupied\",\n    \"available_date\": null,\n    \"created_at\": \"2024-01-10T00:00:00Z\",\n    \"updated_at\": \"2026-08-02T14:30:00Z\"\n  }\n]"}],"_postman_id":"8921896a-6080-4e75-aaad-d171a48baec0"},{"name":"Get unit","id":"999fe1cc-ceb1-4804-9c91-8e5c6ad47944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/units/9001","description":"<p>Returns one unit.</p>\n","urlObject":{"path":["communities","123","units","9001"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"67fb1be4-e1bb-489f-b09d-b70e3229a207","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/units/9001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 9001,\n  \"unit_number\": \"204\",\n  \"floor\": 2,\n  \"floor_plan_id\": 55,\n  \"care_type_id\": 2,\n  \"square_feet\": 780,\n  \"market_rate\": 5200.0,\n  \"floor_price\": 4800.0,\n  \"ceiling_price\": 5600.0,\n  \"amenities\": [\n    \"Balcony\",\n    \"Walk-in shower\"\n  ],\n  \"description\": \"Corner unit overlooking the garden\",\n  \"status\": \"available\",\n  \"available_date\": \"2026-10-15\",\n  \"created_at\": \"2024-01-10T00:00:00Z\",\n  \"updated_at\": \"2026-09-20T08:00:00Z\"\n}"}],"_postman_id":"999fe1cc-ceb1-4804-9c91-8e5c6ad47944"},{"name":"Get floor plans","id":"2e54d4ee-5b2c-4f88-8f27-3f38bf56b803","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/floor_plans","description":"<p>Lists the community's floor plans. Units refer to them by <code>floor_plan_id</code>.</p>\n","urlObject":{"path":["communities","123","floor_plans"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"b4eb2e11-14cf-4501-ab94-6fc700a8c370","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/floor_plans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 54,\n    \"name\": \"Studio\",\n    \"bedrooms\": 0,\n    \"bathrooms\": 1,\n    \"square_feet\": 560\n  },\n  {\n    \"id\": 55,\n    \"name\": \"One Bedroom Deluxe\",\n    \"bedrooms\": 1,\n    \"bathrooms\": 1,\n    \"square_feet\": 780\n  }\n]"}],"_postman_id":"2e54d4ee-5b2c-4f88-8f27-3f38bf56b803"},{"name":"Get care types","id":"42c1f00c-4a06-4552-abfc-fcc6d0b3b37a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/care_types","description":"<p>Lists the levels of care the community offers.</p>\n","urlObject":{"path":["communities","123","care_types"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"6fe1fd7e-1526-47c3-9c34-b7083e131f9e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/care_types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 1,\n    \"name\": \"Independent Living\"\n  },\n  {\n    \"id\": 2,\n    \"name\": \"Assisted Living\"\n  },\n  {\n    \"id\": 3,\n    \"name\": \"Memory Care\"\n  }\n]"}],"_postman_id":"42c1f00c-4a06-4552-abfc-fcc6d0b3b37a"}],"id":"36256c40-d1eb-4174-ac5c-8dd027e20c26","description":"<p>The community's units, floor plans and care types. ActiveDEMAND imports units so that available inventory and pricing can be used in marketing and reporting.</p>\n<p>Unit <code>status</code> is one of <code>available</code>, <code>occupied</code>, <code>on_notice</code>, <code>reserved</code> or <code>off_census</code>.</p>\n","_postman_id":"36256c40-d1eb-4174-ac5c-8dd027e20c26"},{"name":"Deposits","item":[{"name":"Get all deposits","id":"33de3de9-7e85-4852-b346-538c2276eb82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/deposits?prospect_id=123455&status=Received&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","description":"<p>Lists the community's deposits, newest first.</p>\n","urlObject":{"path":["communities","123","deposits"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Optional. Only this prospect's deposits.</p>\n","type":"text/plain"},"key":"prospect_id","value":"123455"},{"description":{"content":"<p>Optional. Only deposits with this status label.</p>\n","type":"text/plain"},"key":"status","value":"Received"},{"description":{"content":"<p>Optional. ISO 8601 timestamp; only records created or changed after this time are returned.</p>\n","type":"text/plain"},"key":"updated_since","value":"2026-09-01T00:00:00Z"},{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"c12aa433-4e01-4a47-ab44-62ba00e997e5","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities/123/deposits?prospect_id=123455&status=Received&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities","123","deposits"],"query":[{"key":"prospect_id","value":"123455","description":"Optional. Only this prospect's deposits."},{"key":"status","value":"Received","description":"Optional. Only deposits with this status label."},{"key":"updated_since","value":"2026-09-01T00:00:00Z","description":"Optional. ISO 8601 timestamp; only records created or changed after this time are returned."},{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 6655,\n    \"prospect_id\": 123455,\n    \"unit_id\": 9001,\n    \"name\": \"Reservation deposit - Unit 204\",\n    \"description\": \"Holds unit 204 for a September move-in.\",\n    \"deposit_type\": \"Reservation\",\n    \"status\": \"Received\",\n    \"amount\": 2500.0,\n    \"tax_amount\": 0.0,\n    \"currency\": \"USD\",\n    \"payment_type\": \"Check\",\n    \"received_at\": \"2026-08-20T15:30:00Z\",\n    \"cancelled_at\": null,\n    \"created_at\": \"2026-08-20T11:00:00Z\",\n    \"updated_at\": \"2026-08-20T15:30:00Z\"\n  }\n]"}],"_postman_id":"33de3de9-7e85-4852-b346-538c2276eb82"},{"name":"Get deposit","id":"6be44ffc-11d2-4096-86b7-8f539c8804bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/deposits/6655","description":"<p>Returns one deposit.</p>\n","urlObject":{"path":["communities","123","deposits","6655"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"32f900b8-608d-4b6a-a041-ef4335a5f568","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/deposits/6655"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 6655,\n  \"prospect_id\": 123455,\n  \"unit_id\": 9001,\n  \"name\": \"Reservation deposit - Unit 204\",\n  \"description\": \"Holds unit 204 for a September move-in.\",\n  \"deposit_type\": \"Reservation\",\n  \"status\": \"Received\",\n  \"amount\": 2500.0,\n  \"tax_amount\": 0.0,\n  \"currency\": \"USD\",\n  \"payment_type\": \"Check\",\n  \"received_at\": \"2026-08-20T15:30:00Z\",\n  \"cancelled_at\": null,\n  \"created_at\": \"2026-08-20T11:00:00Z\",\n  \"updated_at\": \"2026-08-20T15:30:00Z\"\n}"},{"id":"971b36be-30b4-4fd5-8962-439f07610cd3","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/deposits/6655"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"error_code\": 404,\n  \"error_message\": \"Deposit 6655 not found\"\n}"}],"_postman_id":"6be44ffc-11d2-4096-86b7-8f539c8804bf"}],"id":"5c5dbcac-2bbc-4349-9b79-0dcfdef09ab2","description":"<p>Deposits taken to hold a unit ahead of a move-in. A deposit is the earliest firm commitment in the sales cycle, so ActiveDEMAND attributes deposits, as well as move-ins, to the marketing that produced them. For that it needs each deposit's amount, the date it was received, and whether it was later cancelled or refunded.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Notes</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>prospect_id</code></td>\n<td>Required. The prospect the deposit belongs to.</td>\n</tr>\n<tr>\n<td><code>unit_id</code></td>\n<td>The unit it holds, or <code>null</code> if it isn't tied to a unit yet.</td>\n</tr>\n<tr>\n<td><code>name</code>, <code>description</code></td>\n<td>Free text. Put refund details, billing codes or notes in <code>description</code>.</td>\n</tr>\n<tr>\n<td><code>deposit_type</code></td>\n<td>The CRM's own label, for example <code>Reservation</code> or <code>Waitlist</code>.</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>The CRM's own label, for example <code>Pending</code>, <code>Received</code> or <code>Refunded</code>.</td>\n</tr>\n<tr>\n<td><code>amount</code>, <code>tax_amount</code></td>\n<td>Numbers.</td>\n</tr>\n<tr>\n<td><code>currency</code></td>\n<td>ISO 4217 code, for example <code>USD</code>. Leave it out to use the community's currency.</td>\n</tr>\n<tr>\n<td><code>payment_type</code></td>\n<td>One of <code>Credit Card</code>, <code>Cash</code>, <code>Check</code>, <code>Bank Transfer</code> or <code>N/A</code>.</td>\n</tr>\n<tr>\n<td><code>received_at</code></td>\n<td>When the money was received. <code>null</code> while the deposit is still pending.</td>\n</tr>\n<tr>\n<td><code>cancelled_at</code></td>\n<td>When the deposit was cancelled or refunded. <code>null</code> otherwise.</td>\n</tr>\n</tbody>\n</table>\n</div><p>ActiveDEMAND counts a deposit as a conversion when <code>received_at</code> is set and <code>cancelled_at</code> is not, and dates it by <code>received_at</code>. <code>deposit_type</code> and <code>status</code> are stored as they are sent, so use your CRM's own values; no lookup endpoint is needed.</p>\n<p>A prospect can have more than one deposit, for example after a refund and a later re-deposit, so return each one as its own record rather than overwriting the previous one.</p>\n","_postman_id":"5c5dbcac-2bbc-4349-9b79-0dcfdef09ab2"},{"name":"Move-Ins","item":[{"name":"Get all move-ins","id":"91878f7c-882b-457f-abe4-dbcea5065af2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/move_ins?prospect_id=123455&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","description":"<p>Lists the community's move-ins.</p>\n","urlObject":{"path":["communities","123","move_ins"],"host":["https://crm.example.com/api"],"query":[{"description":{"content":"<p>Optional. Only this prospect's move-ins.</p>\n","type":"text/plain"},"key":"prospect_id","value":"123455"},{"description":{"content":"<p>Optional. ISO 8601 timestamp; only records created or changed after this time are returned.</p>\n","type":"text/plain"},"key":"updated_since","value":"2026-09-01T00:00:00Z"},{"description":{"content":"<p>Page number, starting at 0.</p>\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"<p>Records per page (max 500).</p>\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"f8decdf5-5bd3-434b-b6df-d8356116f6cd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":{"raw":"https://crm.example.com/api/communities/123/move_ins?prospect_id=123455&updated_since=2026-09-01T00:00:00Z&page=0&limit=100","host":["https://crm.example.com/api"],"path":["communities","123","move_ins"],"query":[{"key":"prospect_id","value":"123455","description":"Optional. Only this prospect's move-ins."},{"key":"updated_since","value":"2026-09-01T00:00:00Z","description":"Optional. ISO 8601 timestamp; only records created or changed after this time are returned."},{"key":"page","value":"0","description":"Page number, starting at 0."},{"key":"limit","value":"100","description":"Records per page (max 500)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 7788,\n    \"prospect_id\": 123455,\n    \"unit_id\": 9001,\n    \"care_type_id\": 2,\n    \"status\": \"current\",\n    \"deposit_date\": \"2026-08-20\",\n    \"move_in_date\": \"2026-09-01\",\n    \"move_out_date\": null,\n    \"monthly_rate\": 5200.0,\n    \"community_fee\": 2500.0,\n    \"created_at\": \"2026-08-20T11:00:00Z\",\n    \"updated_at\": \"2026-09-01T09:00:00Z\"\n  }\n]"}],"_postman_id":"91878f7c-882b-457f-abe4-dbcea5065af2"}],"id":"f47d311d-05c2-40a5-802a-98dca21dadd1","description":"<p>Move-ins (residency or housing contracts). ActiveDEMAND attributes move-ins and their revenue to the marketing that produced them. For that it needs each move-in's date, unit and rate; the prospect's <code>move_in_value</code> on its own doesn't carry those.</p>\n<p><code>deposit_date</code> is the date of the deposit that became this move-in; the deposit itself, with its amount and history, is in <strong>Deposits</strong>.</p>\n<p><code>status</code> is one of <code>pending</code>, <code>current</code>, <code>notice</code>, <code>moved_out</code> or <code>cancelled</code>.</p>\n","_postman_id":"f47d311d-05c2-40a5-802a-98dca21dadd1"},{"name":"Lookups","item":[{"name":"Get lead sources","id":"3cc444c1-5662-4564-bec0-7e4c0acd8902","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/lead_sources","description":"<p>Lists lead sources. Prospects refer to them by <code>lead_source_id</code>.</p>\n","urlObject":{"path":["communities","123","lead_sources"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"0359c363-c140-4f77-9966-88d89471496f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/lead_sources"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 10,\n    \"name\": \"Website\",\n    \"category\": \"Digital\",\n    \"active\": true\n  },\n  {\n    \"id\": 11,\n    \"name\": \"A Place for Mom\",\n    \"category\": \"Referral Agency\",\n    \"active\": true\n  },\n  {\n    \"id\": 12,\n    \"name\": \"Newspaper\",\n    \"category\": \"Print\",\n    \"active\": false\n  }\n]"}],"_postman_id":"3cc444c1-5662-4564-bec0-7e4c0acd8902"},{"name":"Get lost reasons","id":"dc6773e5-6c1a-4a89-982f-61bec4346ee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/lost_reasons","description":"<p>Lists lost reasons. Prospects refer to them by <code>lost_reason_id</code>.</p>\n","urlObject":{"path":["communities","123","lost_reasons"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"d534644f-914a-4524-866e-4f6dcd6e1fa5","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/lost_reasons"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 1,\n    \"name\": \"Chose competitor\",\n    \"active\": true\n  },\n  {\n    \"id\": 2,\n    \"name\": \"Cost\",\n    \"active\": true\n  },\n  {\n    \"id\": 3,\n    \"name\": \"Deceased\",\n    \"active\": true\n  }\n]"}],"_postman_id":"dc6773e5-6c1a-4a89-982f-61bec4346ee3"},{"name":"Get influencer relationships","id":"49851713-f9c5-40c1-86ad-693dbed05a3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/relationships","description":"<p>Lists relationship types for influencer contacts. Influencers refer to them by <code>relationship_id</code>.</p>\n","urlObject":{"path":["communities","123","relationships"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"bb301cf6-156a-4857-94ed-e767ca646159","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/relationships"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 1,\n    \"name\": \"Daughter\"\n  },\n  {\n    \"id\": 2,\n    \"name\": \"Son\"\n  },\n  {\n    \"id\": 3,\n    \"name\": \"Spouse\"\n  },\n  {\n    \"id\": 4,\n    \"name\": \"Power of Attorney\"\n  }\n]"}],"_postman_id":"49851713-f9c5-40c1-86ad-693dbed05a3f"}],"id":"dbc554bf-0e2d-4d2c-af48-cb0dd363bec9","description":"<p>The values a prospect or contact field can take. ActiveDEMAND uses them to map its own lead sources and outcomes onto the CRM's. Inactive values should still be returned, flagged <code>active: false</code>, because existing records may still use them.</p>\n","_postman_id":"dbc554bf-0e2d-4d2c-af48-cb0dd363bec9"},{"name":"Sales Counselors","item":[{"name":"Get sales counselors","id":"57cbf388-2a38-4cdd-96e3-800c151d6a91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/sales_counselors","description":"<p>Lists the community's sales counselors. Inactive counselors should still be returned, flagged <code>active: false</code>, because existing prospects and activities may still refer to them.</p>\n","urlObject":{"path":["communities","123","sales_counselors"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"8e67d58d-4545-425b-b37d-f81bd857b43b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/sales_counselors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 4321,\n    \"first_name\": \"Mary\",\n    \"last_name\": \"Smith\",\n    \"email_address\": \"mary.smith@community.com\",\n    \"active\": true\n  },\n  {\n    \"id\": 90876,\n    \"first_name\": \"Bob\",\n    \"last_name\": \"Smith\",\n    \"email_address\": \"bob.smith@community1.com\",\n    \"active\": false\n  }\n]"}],"_postman_id":"57cbf388-2a38-4cdd-96e3-800c151d6a91"}],"id":"14c45215-81cb-4a1e-b5b8-24e3905c1f0d","description":"<p>The community's sales staff. Prospects and activities refer to them by <code>sales_counselor_id</code>.</p>\n","_postman_id":"14c45215-81cb-4a1e-b5b8-24e3905c1f0d"},{"name":"Webhooks","item":[{"name":"Get webhooks","id":"1f67215f-7b86-43a7-aea6-cd26f7e8f538","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/webhooks","description":"<p>Lists the community's registered webhooks. The secret is never returned.</p>\n","urlObject":{"path":["communities","123","webhooks"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"5e83b144-5633-4e39-8e92-5e4ce942e0e8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n  {\n    \"id\": 4321,\n    \"post_url\": \"https://api.activedemand.com/v1/contacts/crm_name?api-key=AD_API_KEY&data_import_id=5432\",\n    \"events\": [\n      \"prospect.created\",\n      \"prospect.updated\",\n      \"prospect.deleted\",\n      \"activity.created\",\n      \"activity.updated\"\n    ]\n  }\n]"}],"_postman_id":"1f67215f-7b86-43a7-aea6-cd26f7e8f538"},{"name":"Create webhook","id":"c1b92906-0763-49dd-aa21-180de7ab7547","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"post_url\": \"https://api.activedemand.com/v1/contacts/crm_name?api-key=AD_API_KEY&data_import_id=5432\",\n  \"events\": [\n    \"prospect.created\",\n    \"prospect.updated\",\n    \"prospect.deleted\",\n    \"activity.created\",\n    \"activity.updated\"\n  ],\n  \"secret\": \"WEBHOOK_SIGNING_SECRET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/webhooks","description":"<p>Registers a webhook. <code>events</code> is optional; leave it out to receive every event. <code>secret</code> is optional; see <em>Signing</em> in the folder description.</p>\n","urlObject":{"path":["communities","123","webhooks"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"528e0d09-b181-4b12-bfa0-c8763b75b56b","name":"Created","originalRequest":{"method":"POST","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"post_url\": \"https://api.activedemand.com/v1/contacts/crm_name?api-key=AD_API_KEY&data_import_id=5432\",\n  \"events\": [\n    \"prospect.created\",\n    \"prospect.updated\",\n    \"prospect.deleted\",\n    \"activity.created\",\n    \"activity.updated\"\n  ],\n  \"secret\": \"WEBHOOK_SIGNING_SECRET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://crm.example.com/api/communities/123/webhooks"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"id\": 4321,\n  \"post_url\": \"https://api.activedemand.com/v1/contacts/crm_name?api-key=AD_API_KEY&data_import_id=5432\",\n  \"events\": [\n    \"prospect.created\",\n    \"prospect.updated\",\n    \"prospect.deleted\",\n    \"activity.created\",\n    \"activity.updated\"\n  ]\n}"}],"_postman_id":"c1b92906-0763-49dd-aa21-180de7ab7547"},{"name":"Delete webhook","id":"98d38718-e352-4494-b1b5-458e03c42f1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/webhooks/4321","description":"<p>Removes a webhook.</p>\n","urlObject":{"path":["communities","123","webhooks","4321"],"host":["https://crm.example.com/api"],"query":[],"variable":[]}},"response":[{"id":"3a69bccd-a62e-417c-bf69-42c3a6bc17b9","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"X-Api-Key","value":"CRM_API_KEY","type":"text"}],"url":"https://crm.example.com/api/communities/123/webhooks/4321"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"98d38718-e352-4494-b1b5-458e03c42f1c"}],"id":"b2a3ad1d-e21b-4f85-a049-3ec4d94d35dc","description":"<p>ActiveDEMAND registers a webhook for each community it syncs. The CRM should POST to every registered <code>post_url</code> when any of these events happens:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Event</th>\n<th>When</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>prospect.created</code></td>\n<td>A prospect is created</td>\n</tr>\n<tr>\n<td><code>prospect.updated</code></td>\n<td>A prospect, or one of its contacts, changes</td>\n</tr>\n<tr>\n<td><code>prospect.deleted</code></td>\n<td>A prospect is deleted or merged</td>\n</tr>\n<tr>\n<td><code>activity.created</code></td>\n<td>An activity is created</td>\n</tr>\n<tr>\n<td><code>activity.updated</code></td>\n<td>An activity is changed, completed or cancelled</td>\n</tr>\n</tbody>\n</table>\n</div><p>Each post wraps the record in an envelope. <code>data</code> is the same JSON the matching GET endpoint returns. For <code>prospect.deleted</code>, <code>data</code> is the record from <strong>Get deleted prospects</strong>.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"event\": \"prospect.updated\",\n  \"community_id\": 123,\n  \"occurred_at\": \"2026-09-14T11:02:00Z\",\n  \"data\": { \"id\": 123455, \"stage\": \"Tour\", \"...\": \"same as Get prospect\" }\n}\n</code></pre>\n<p><strong>Signing.</strong> If a <code>secret</code> is set when the webhook is registered, sign each post: send <code>X-Signature: sha256=&lt;hex HMAC-SHA256 of the raw body, keyed with the secret&gt;</code>.</p>\n<p><strong>Retries.</strong> If the <code>post_url</code> doesn't return a 2XX, retry with exponential backoff for at least 24 hours. ActiveDEMAND's scheduled <code>updated_since</code> sync is the backstop for anything that still doesn't get through.</p>\n","_postman_id":"b2a3ad1d-e21b-4f85-a049-3ec4d94d35dc"},{"name":"ActiveDEMAND Contact History (CRM calls ActiveDEMAND)","item":[{"name":"Look up a contact's history in ActiveDEMAND","id":"72a247ca-5534-41be-9d6e-c02d19030f0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"AD_API_KEY","description":"<p>The ActiveDEMAND API key saved for this community.</p>\n","type":"text"}],"url":"https://api.activedemand.com/v1/contacts/lookup.json?crm_id=123543&history_types=SiteVisit,SubmittedForm,EmailOpen,WonDeal","description":"<p><strong>This request goes to ActiveDEMAND's API, not the CRM's.</strong> It looks up a contact by the CRM's contact ID and returns the contact with its engagement history. Full reference: <a href=\"https://developers.activedemand.com/#aeb196d7-15b9-4e94-9668-35d4746953d7\">https://developers.activedemand.com/#aeb196d7-15b9-4e94-9668-35d4746953d7</a></p>\n","urlObject":{"protocol":"https","path":["v1","contacts","lookup.json"],"host":["api","activedemand","com"],"query":[{"description":{"content":"<p>The CRM's own ID for the contact.</p>\n","type":"text/plain"},"key":"crm_id","value":"123543"},{"description":{"content":"<p>Comma-separated list of the history types to return.</p>\n","type":"text/plain"},"key":"history_types","value":"SiteVisit,SubmittedForm,EmailOpen,WonDeal"}],"variable":[]}},"response":[],"_postman_id":"72a247ca-5534-41be-9d6e-c02d19030f0f"}],"id":"f906738e-40e8-4f4d-9f00-b704bf3f915e","description":"<p>A big advantage of ActiveDEMAND is that it tracks how each prospect engages with the community's websites, emails, phone calls and so on. Sales people find this useful because it tells them what the prospect has been looking at.</p>\n<p>To keep server load down, the CRM shouldn't copy this history over in bulk. It should pull the history from ActiveDEMAND at the point of use, inside the CRM. For example, a sales user who wants the context on a prospect clicks a button and the CRM loads that prospect's history from ActiveDEMAND.</p>\n<p>The CRM pulls a contact's history from ActiveDEMAND's API using the ActiveDEMAND API key and the CRM's own contact ID. ActiveDEMAND stores the CRM contact ID whenever it creates a contact in the CRM, or retrieves one from it.</p>\n<h2 id=\"store-the-activedemand-api-key\">Store the ActiveDEMAND API key</h2>\n<p>The CRM will need an ActiveDEMAND API key for this integration. We recommend adding an ActiveDEMAND Integration setting where the user can save the key. In 90% of deployments ActiveDEMAND uses a separate API key for each community, so the connection has to be set up per community.</p>\n<h2 id=\"formatting-the-history\">Formatting the history</h2>\n<p>The lookup returns raw JSON. The CRM's development team will need to format the history to fit the CRM's own user experience.</p>\n<p>Sample JSON for each history type is in the ActiveDEMAND API documentation: <a href=\"https://developers.activedemand.com/#da07da8a-e1a6-49b2-81ff-02befe05ec99\">https://developers.activedemand.com/#da07da8a-e1a6-49b2-81ff-02befe05ec99</a>. The contact structure is at <a href=\"https://developers.activedemand.com/#1fd6894d-7882-4961-be2b-5106925ce863\">https://developers.activedemand.com/#1fd6894d-7882-4961-be2b-5106925ce863</a>.</p>\n<p>We're also open to providing a formatted iframe for each record. That means less development for your team. The downsides are that the formatting may not match your UX, and an iframe is not the most flexible way to present history data.</p>\n","_postman_id":"f906738e-40e8-4f4d-9f00-b704bf3f915e"}],"variable":[{"key":"base_url","value":"https://crm.example.com/api"},{"key":"crm-api-key","value":"CRM_API_KEY"},{"key":"ad-api-key","value":"AD_API_KEY"},{"key":"crm-name","value":"crm_name"},{"key":"community-id","value":"123"},{"key":"contact-id","value":"123543"},{"key":"prospect-id","value":"123455"},{"key":"activity-id","value":"4321"},{"key":"unit-id","value":"9001"},{"key":"deposit-id","value":"6655"},{"key":"webhook-id","value":"4321"}]}