API Documentation
Deal ¶
Overview
A Deal holds information about a Real Estate Deal/Transaction.
Each deal has the following attributes:
-
An MLS listing (Optional). (If the listing is missing, the deal is called a Hippocket)
-
Brand this deal belongs to (Optional)
-
Context. A key-value object consisting context of the deal (dates, prices, names, etc)
-
Proposed Values. A key-value object consisting of values that we have extracted from different sources and we propose them to be used instead of context.
-
Roles. People and the role they have in this deal.
Context
A deal may consist of many different data that are gathered from different sources. MLS, DCAD, user-submitted-forms and the user interfaces are current data sources.
contexts are stored in deal.deal_context object.
For example, street_name of a deal can be fetched from deal.deal_context.street_name.
Contexts are defined by each brand. Please refer to brand documentation to see how you can get a list of available contexts for each brand.
Get a deal ¶
Get a dealGET/deals/:id
Example URI
GET /deals/:id
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Response
200Body
{
"code": "OK",
"data": {
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-25T21:39:06.318Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "c74ddd9c-d6ee-4a41-84f1-c0f9e505d86e",
"created_at": 1787693946.393867,
"updated_at": 1787693946.393867,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "SellerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "57c418d8-e142-44ed-b452-23250a8d8818",
"searchable": "'dalla':1",
"deleted_at": null
},
"county": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "county",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "36c3b6e4-eeeb-4f74-be3f-1455710efba2",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"full_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "full_address",
"text": "5020 Junius Street Dallas, TX 75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "7e96f472-7e28-437f-afeb-f31e6af3ccc8",
"searchable": "'5020':1 '75214':6 'dalla':4 'junius':2 'street':3 'tx':5",
"deleted_at": null
},
"list_date": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_date",
"text": null,
"number": null,
"date": 1425189600,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a803ee0c-7cfd-4947-83a1-cde6eb647a54",
"searchable": null,
"deleted_at": null
},
"list_price": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_price",
"text": null,
"number": 498000,
"date": null,
"data_type": "Number",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4e710a77-a710-4eab-80ea-9357dbd422b5",
"searchable": "'498000':1",
"deleted_at": null
},
"listing_status": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "listing_status",
"text": "Sold",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "af37e817-7cee-4813-99e7-1e080d64f882",
"searchable": "'sold':1",
"deleted_at": null
},
"lot_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "lot_number",
"text": "14",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "d5f53be3-92b5-45b3-9737-9ac13a32f774",
"searchable": "'14':1",
"deleted_at": null
},
"mls_area_major": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_major",
"text": "DALLAS EAST (12)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "dff917e4-93bb-4ff5-9935-8fb7eb49e90a",
"searchable": "'12':3 'dalla':1 'east':2",
"deleted_at": null
},
"mls_area_minor": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_minor",
"text": "EAST DALLAS (11)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "9ddca0f1-d2f9-4360-b2cc-2855b4508c4d",
"searchable": "'11':3 'dalla':2 'east':1",
"deleted_at": null
},
"mls_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_number",
"text": "13103256",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "38fc0439-e5f4-4e8d-80cb-35b645211900",
"searchable": "'13103256':1",
"deleted_at": null
},
"photo": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "photo",
"text": "http://cdn.rechat.co/52656495.jpg",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "65418359-2080-4b2c-9591-9c0654e2b61c",
"searchable": "'/52656495.jpg':3 'cdn.rechat.co':2 'cdn.rechat.co/52656495.jpg':1",
"deleted_at": null
},
"postal_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "postal_code",
"text": "75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a571b984-6140-4eba-9e1c-bf7bd942578d",
"searchable": "'75214':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"state": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state",
"text": "Texas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "bfe9e1e8-1b36-41ca-890f-90fd4cafdc34",
"searchable": "'texa':1",
"deleted_at": null
},
"state_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state_code",
"text": "TX",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "262c7332-7bd8-4ea7-b4a3-652f5aba1609",
"searchable": "'tx':1",
"deleted_at": null
},
"street_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_address",
"text": "5020 Junius Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "01fb7225-e07b-48f6-8b97-5009612dc7f6",
"searchable": "'5020':1 'junius':2 'street':3",
"deleted_at": null
},
"street_dir_prefix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_dir_prefix",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "2891b6a2-1b31-4798-a4d7-b3a874705174",
"searchable": "",
"deleted_at": null
},
"street_name": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_name",
"text": "Junius",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "067001a7-d083-46d7-aa58-3ac398ffb836",
"searchable": "'junius':1",
"deleted_at": null
},
"street_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_number",
"text": "5020",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4c48f8bd-74a3-40f1-a203-1a8e242901d0",
"searchable": "'5020':1",
"deleted_at": null
},
"street_suffix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_suffix",
"text": "Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "8565c808-721b-417c-baaa-c308c2cd921c",
"searchable": "'street':1",
"deleted_at": null
},
"subdivision": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "subdivision",
"text": "Munger Place",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e0d9f6af-8cbf-4a67-b3e2-e1026c4396b3",
"searchable": "'munger':1 'place':2",
"deleted_at": null
},
"unit_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "unit_number",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e69c79cf-7e08-4106-bd39-e7774bf6801d",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Get deals created by a user ¶
Get deals created by a userGET/deals
This endpoint is marked for deprecation on 2026-01-01.
Example URI
GET /deals
Response
200Body
{
"code": "OK",
"data": [
{
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-25T21:39:06.318Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "c74ddd9c-d6ee-4a41-84f1-c0f9e505d86e",
"created_at": 1787693946.393867,
"updated_at": 1787693946.393867,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "SellerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "57c418d8-e142-44ed-b452-23250a8d8818",
"searchable": "'dalla':1",
"deleted_at": null
},
"county": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "county",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "36c3b6e4-eeeb-4f74-be3f-1455710efba2",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"full_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "full_address",
"text": "5020 Junius Street Dallas, TX 75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "7e96f472-7e28-437f-afeb-f31e6af3ccc8",
"searchable": "'5020':1 '75214':6 'dalla':4 'junius':2 'street':3 'tx':5",
"deleted_at": null
},
"list_date": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_date",
"text": null,
"number": null,
"date": 1425189600,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a803ee0c-7cfd-4947-83a1-cde6eb647a54",
"searchable": null,
"deleted_at": null
},
"list_price": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_price",
"text": null,
"number": 498000,
"date": null,
"data_type": "Number",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4e710a77-a710-4eab-80ea-9357dbd422b5",
"searchable": "'498000':1",
"deleted_at": null
},
"listing_status": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "listing_status",
"text": "Sold",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "af37e817-7cee-4813-99e7-1e080d64f882",
"searchable": "'sold':1",
"deleted_at": null
},
"lot_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "lot_number",
"text": "14",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "d5f53be3-92b5-45b3-9737-9ac13a32f774",
"searchable": "'14':1",
"deleted_at": null
},
"mls_area_major": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_major",
"text": "DALLAS EAST (12)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "dff917e4-93bb-4ff5-9935-8fb7eb49e90a",
"searchable": "'12':3 'dalla':1 'east':2",
"deleted_at": null
},
"mls_area_minor": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_minor",
"text": "EAST DALLAS (11)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "9ddca0f1-d2f9-4360-b2cc-2855b4508c4d",
"searchable": "'11':3 'dalla':2 'east':1",
"deleted_at": null
},
"mls_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_number",
"text": "13103256",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "38fc0439-e5f4-4e8d-80cb-35b645211900",
"searchable": "'13103256':1",
"deleted_at": null
},
"photo": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "photo",
"text": "http://cdn.rechat.co/52656495.jpg",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "65418359-2080-4b2c-9591-9c0654e2b61c",
"searchable": "'/52656495.jpg':3 'cdn.rechat.co':2 'cdn.rechat.co/52656495.jpg':1",
"deleted_at": null
},
"postal_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "postal_code",
"text": "75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a571b984-6140-4eba-9e1c-bf7bd942578d",
"searchable": "'75214':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"state": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state",
"text": "Texas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "bfe9e1e8-1b36-41ca-890f-90fd4cafdc34",
"searchable": "'texa':1",
"deleted_at": null
},
"state_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state_code",
"text": "TX",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "262c7332-7bd8-4ea7-b4a3-652f5aba1609",
"searchable": "'tx':1",
"deleted_at": null
},
"street_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_address",
"text": "5020 Junius Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "01fb7225-e07b-48f6-8b97-5009612dc7f6",
"searchable": "'5020':1 'junius':2 'street':3",
"deleted_at": null
},
"street_dir_prefix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_dir_prefix",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "2891b6a2-1b31-4798-a4d7-b3a874705174",
"searchable": "",
"deleted_at": null
},
"street_name": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_name",
"text": "Junius",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "067001a7-d083-46d7-aa58-3ac398ffb836",
"searchable": "'junius':1",
"deleted_at": null
},
"street_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_number",
"text": "5020",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4c48f8bd-74a3-40f1-a203-1a8e242901d0",
"searchable": "'5020':1",
"deleted_at": null
},
"street_suffix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_suffix",
"text": "Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "8565c808-721b-417c-baaa-c308c2cd921c",
"searchable": "'street':1",
"deleted_at": null
},
"subdivision": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "subdivision",
"text": "Munger Place",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e0d9f6af-8cbf-4a67-b3e2-e1026c4396b3",
"searchable": "'munger':1 'place':2",
"deleted_at": null
},
"unit_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "unit_number",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e69c79cf-7e08-4106-bd39-e7774bf6801d",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 0
}
}Get all deals belonging to a brand ¶
Get all deals belonging to a brandGET/brands/:brand/deals
Example URI
GET /brands/:brand/deals
URI Parameters
- brand
string(required) Example: cbce1035-783a-4506-8b2e-dc0fcae7c337
Response
200Body
{
"code": "OK",
"data": [
{
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-25T21:39:06.318Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "c74ddd9c-d6ee-4a41-84f1-c0f9e505d86e",
"created_at": 1787693946.393867,
"updated_at": 1787693946.393867,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "SellerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "57c418d8-e142-44ed-b452-23250a8d8818",
"searchable": "'dalla':1",
"deleted_at": null
},
"county": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "county",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "36c3b6e4-eeeb-4f74-be3f-1455710efba2",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"full_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "full_address",
"text": "5020 Junius Street Dallas, TX 75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "7e96f472-7e28-437f-afeb-f31e6af3ccc8",
"searchable": "'5020':1 '75214':6 'dalla':4 'junius':2 'street':3 'tx':5",
"deleted_at": null
},
"list_date": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_date",
"text": null,
"number": null,
"date": 1425189600,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a803ee0c-7cfd-4947-83a1-cde6eb647a54",
"searchable": null,
"deleted_at": null
},
"list_price": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_price",
"text": null,
"number": 498000,
"date": null,
"data_type": "Number",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4e710a77-a710-4eab-80ea-9357dbd422b5",
"searchable": "'498000':1",
"deleted_at": null
},
"listing_status": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "listing_status",
"text": "Sold",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "af37e817-7cee-4813-99e7-1e080d64f882",
"searchable": "'sold':1",
"deleted_at": null
},
"lot_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "lot_number",
"text": "14",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "d5f53be3-92b5-45b3-9737-9ac13a32f774",
"searchable": "'14':1",
"deleted_at": null
},
"mls_area_major": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_major",
"text": "DALLAS EAST (12)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "dff917e4-93bb-4ff5-9935-8fb7eb49e90a",
"searchable": "'12':3 'dalla':1 'east':2",
"deleted_at": null
},
"mls_area_minor": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_minor",
"text": "EAST DALLAS (11)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "9ddca0f1-d2f9-4360-b2cc-2855b4508c4d",
"searchable": "'11':3 'dalla':2 'east':1",
"deleted_at": null
},
"mls_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_number",
"text": "13103256",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "38fc0439-e5f4-4e8d-80cb-35b645211900",
"searchable": "'13103256':1",
"deleted_at": null
},
"photo": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "photo",
"text": "http://cdn.rechat.co/52656495.jpg",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "65418359-2080-4b2c-9591-9c0654e2b61c",
"searchable": "'/52656495.jpg':3 'cdn.rechat.co':2 'cdn.rechat.co/52656495.jpg':1",
"deleted_at": null
},
"postal_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "postal_code",
"text": "75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a571b984-6140-4eba-9e1c-bf7bd942578d",
"searchable": "'75214':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"state": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state",
"text": "Texas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "bfe9e1e8-1b36-41ca-890f-90fd4cafdc34",
"searchable": "'texa':1",
"deleted_at": null
},
"state_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state_code",
"text": "TX",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "262c7332-7bd8-4ea7-b4a3-652f5aba1609",
"searchable": "'tx':1",
"deleted_at": null
},
"street_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_address",
"text": "5020 Junius Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "01fb7225-e07b-48f6-8b97-5009612dc7f6",
"searchable": "'5020':1 'junius':2 'street':3",
"deleted_at": null
},
"street_dir_prefix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_dir_prefix",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "2891b6a2-1b31-4798-a4d7-b3a874705174",
"searchable": "",
"deleted_at": null
},
"street_name": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_name",
"text": "Junius",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "067001a7-d083-46d7-aa58-3ac398ffb836",
"searchable": "'junius':1",
"deleted_at": null
},
"street_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_number",
"text": "5020",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4c48f8bd-74a3-40f1-a203-1a8e242901d0",
"searchable": "'5020':1",
"deleted_at": null
},
"street_suffix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_suffix",
"text": "Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "8565c808-721b-417c-baaa-c308c2cd921c",
"searchable": "'street':1",
"deleted_at": null
},
"subdivision": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "subdivision",
"text": "Munger Place",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e0d9f6af-8cbf-4a67-b3e2-e1026c4396b3",
"searchable": "'munger':1 'place':2",
"deleted_at": null
},
"unit_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "unit_number",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e69c79cf-7e08-4106-bd39-e7774bf6801d",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 2
}
}Get all deals that need backoffice review ¶
Get all deals that need backoffice reviewGET/brands/:brand/deals/inbox
Example URI
GET /brands/:brand/deals/inbox
URI Parameters
- brand
string(required) Example: cbce1035-783a-4506-8b2e-dc0fcae7c337- associations
string(required) Example: deal.inboxes
Response
200Body
{
"code": "OK",
"data": [
{
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-25T21:39:06.318Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1787693950.157257,
"is_draft": false,
"roles": [
{
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "c74ddd9c-d6ee-4a41-84f1-c0f9e505d86e",
"created_at": 1787693946.393867,
"updated_at": 1787693946.393867,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "SellerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "57c418d8-e142-44ed-b452-23250a8d8818",
"searchable": "'dalla':1",
"deleted_at": null
},
"county": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "county",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "36c3b6e4-eeeb-4f74-be3f-1455710efba2",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"full_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "full_address",
"text": "5020 Junius Street Dallas, TX 75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "7e96f472-7e28-437f-afeb-f31e6af3ccc8",
"searchable": "'5020':1 '75214':6 'dalla':4 'junius':2 'street':3 'tx':5",
"deleted_at": null
},
"list_date": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_date",
"text": null,
"number": null,
"date": 1425189600,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a803ee0c-7cfd-4947-83a1-cde6eb647a54",
"searchable": null,
"deleted_at": null
},
"list_price": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_price",
"text": null,
"number": 498000,
"date": null,
"data_type": "Number",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4e710a77-a710-4eab-80ea-9357dbd422b5",
"searchable": "'498000':1",
"deleted_at": null
},
"listing_status": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "listing_status",
"text": "Sold",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "af37e817-7cee-4813-99e7-1e080d64f882",
"searchable": "'sold':1",
"deleted_at": null
},
"lot_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "lot_number",
"text": "14",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "d5f53be3-92b5-45b3-9737-9ac13a32f774",
"searchable": "'14':1",
"deleted_at": null
},
"mls_area_major": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_major",
"text": "DALLAS EAST (12)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "dff917e4-93bb-4ff5-9935-8fb7eb49e90a",
"searchable": "'12':3 'dalla':1 'east':2",
"deleted_at": null
},
"mls_area_minor": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_minor",
"text": "EAST DALLAS (11)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "9ddca0f1-d2f9-4360-b2cc-2855b4508c4d",
"searchable": "'11':3 'dalla':2 'east':1",
"deleted_at": null
},
"mls_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_number",
"text": "13103256",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "38fc0439-e5f4-4e8d-80cb-35b645211900",
"searchable": "'13103256':1",
"deleted_at": null
},
"photo": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "photo",
"text": "http://cdn.rechat.co/52656495.jpg",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "65418359-2080-4b2c-9591-9c0654e2b61c",
"searchable": "'/52656495.jpg':3 'cdn.rechat.co':2 'cdn.rechat.co/52656495.jpg':1",
"deleted_at": null
},
"postal_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "postal_code",
"text": "75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a571b984-6140-4eba-9e1c-bf7bd942578d",
"searchable": "'75214':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"state": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state",
"text": "Texas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "bfe9e1e8-1b36-41ca-890f-90fd4cafdc34",
"searchable": "'texa':1",
"deleted_at": null
},
"state_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state_code",
"text": "TX",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "262c7332-7bd8-4ea7-b4a3-652f5aba1609",
"searchable": "'tx':1",
"deleted_at": null
},
"street_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_address",
"text": "5020 Junius Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "01fb7225-e07b-48f6-8b97-5009612dc7f6",
"searchable": "'5020':1 'junius':2 'street':3",
"deleted_at": null
},
"street_dir_prefix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_dir_prefix",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "2891b6a2-1b31-4798-a4d7-b3a874705174",
"searchable": "",
"deleted_at": null
},
"street_name": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_name",
"text": "Junius",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "067001a7-d083-46d7-aa58-3ac398ffb836",
"searchable": "'junius':1",
"deleted_at": null
},
"street_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_number",
"text": "5020",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4c48f8bd-74a3-40f1-a203-1a8e242901d0",
"searchable": "'5020':1",
"deleted_at": null
},
"street_suffix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_suffix",
"text": "Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "8565c808-721b-417c-baaa-c308c2cd921c",
"searchable": "'street':1",
"deleted_at": null
},
"subdivision": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "subdivision",
"text": "Munger Place",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e0d9f6af-8cbf-4a67-b3e2-e1026c4396b3",
"searchable": "'munger':1 'place':2",
"deleted_at": null
},
"unit_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "unit_number",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e69c79cf-7e08-4106-bd39-e7774bf6801d",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": [
{
"id": "c5e807f0-cfcf-4547-b4b9-a415575392f3",
"brand": "7092a47f-2f4f-4bb3-bdef-6a237c0054e5",
"label": "Contract Inbox",
"created_by": null,
"listing_default": false,
"contract_default": true,
"created_at": 1787693945.415415,
"deleted_at": null,
"type": "deal_inbox"
}
],
"attention_requests": 1,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 0
}
}Search through all deals ¶
Search through all dealsPOST/deals/filter
Sort object looks like the following:
{
$order: {
direction, // DESC or ASC
field, // Used for some of the base properties of the deal like deal.title, deal.created_at, deal.faired_at, deal.property_type
context: { // Used for sorting based on dynamic deal contexts.
type, // Type of field you are applying the sorting to. either `number` or `date`
fields: [] // Array of names of contexts. like ['sales_price', 'list_price']
}
}
}Example URI
POST /deals/filter
Request
Body
{
"query": "5020 Junius Street",
"$order": {
"field": "deals.updated_at",
"direction": "DESC"
},
"limit": 100,
"start": 0
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-25T21:39:06.318Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "c74ddd9c-d6ee-4a41-84f1-c0f9e505d86e",
"created_at": 1787693946.393867,
"updated_at": 1787693946.393867,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "SellerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "57c418d8-e142-44ed-b452-23250a8d8818",
"searchable": "'dalla':1",
"deleted_at": null
},
"county": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "county",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "36c3b6e4-eeeb-4f74-be3f-1455710efba2",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"full_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "full_address",
"text": "5020 Junius Street Dallas, TX 75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "7e96f472-7e28-437f-afeb-f31e6af3ccc8",
"searchable": "'5020':1 '75214':6 'dalla':4 'junius':2 'street':3 'tx':5",
"deleted_at": null
},
"list_date": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_date",
"text": null,
"number": null,
"date": 1425189600,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a803ee0c-7cfd-4947-83a1-cde6eb647a54",
"searchable": null,
"deleted_at": null
},
"list_price": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_price",
"text": null,
"number": 498000,
"date": null,
"data_type": "Number",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4e710a77-a710-4eab-80ea-9357dbd422b5",
"searchable": "'498000':1",
"deleted_at": null
},
"listing_status": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "listing_status",
"text": "Sold",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "af37e817-7cee-4813-99e7-1e080d64f882",
"searchable": "'sold':1",
"deleted_at": null
},
"lot_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "lot_number",
"text": "14",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "d5f53be3-92b5-45b3-9737-9ac13a32f774",
"searchable": "'14':1",
"deleted_at": null
},
"mls_area_major": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_major",
"text": "DALLAS EAST (12)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "dff917e4-93bb-4ff5-9935-8fb7eb49e90a",
"searchable": "'12':3 'dalla':1 'east':2",
"deleted_at": null
},
"mls_area_minor": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_minor",
"text": "EAST DALLAS (11)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "9ddca0f1-d2f9-4360-b2cc-2855b4508c4d",
"searchable": "'11':3 'dalla':2 'east':1",
"deleted_at": null
},
"mls_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_number",
"text": "13103256",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "38fc0439-e5f4-4e8d-80cb-35b645211900",
"searchable": "'13103256':1",
"deleted_at": null
},
"photo": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "photo",
"text": "http://cdn.rechat.co/52656495.jpg",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "65418359-2080-4b2c-9591-9c0654e2b61c",
"searchable": "'/52656495.jpg':3 'cdn.rechat.co':2 'cdn.rechat.co/52656495.jpg':1",
"deleted_at": null
},
"postal_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "postal_code",
"text": "75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a571b984-6140-4eba-9e1c-bf7bd942578d",
"searchable": "'75214':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"state": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state",
"text": "Texas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "bfe9e1e8-1b36-41ca-890f-90fd4cafdc34",
"searchable": "'texa':1",
"deleted_at": null
},
"state_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state_code",
"text": "TX",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "262c7332-7bd8-4ea7-b4a3-652f5aba1609",
"searchable": "'tx':1",
"deleted_at": null
},
"street_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_address",
"text": "5020 Junius Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "01fb7225-e07b-48f6-8b97-5009612dc7f6",
"searchable": "'5020':1 'junius':2 'street':3",
"deleted_at": null
},
"street_dir_prefix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_dir_prefix",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "2891b6a2-1b31-4798-a4d7-b3a874705174",
"searchable": "",
"deleted_at": null
},
"street_name": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_name",
"text": "Junius",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "067001a7-d083-46d7-aa58-3ac398ffb836",
"searchable": "'junius':1",
"deleted_at": null
},
"street_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_number",
"text": "5020",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4c48f8bd-74a3-40f1-a203-1a8e242901d0",
"searchable": "'5020':1",
"deleted_at": null
},
"street_suffix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_suffix",
"text": "Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "8565c808-721b-417c-baaa-c308c2cd921c",
"searchable": "'street':1",
"deleted_at": null
},
"subdivision": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "subdivision",
"text": "Munger Place",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e0d9f6af-8cbf-4a67-b3e2-e1026c4396b3",
"searchable": "'munger':1 'place':2",
"deleted_at": null
},
"unit_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "unit_number",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e69c79cf-7e08-4106-bd39-e7774bf6801d",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 1
}
}Create a deal with a listing ¶
Create a deal with a listingPOST/deals
Example URI
POST /deals
URI Parameters
- associations
string(required) Example: deal.gallery,deal.property_type,brand_property_type.checklists
Request
Body
{
"deal_type": "Buying",
"is_draft": true,
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642"
}Response
200Body
{
"code": "OK",
"data": {
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"gallery": {
"id": "65986bb2-a0cd-11f1-85f5-1a8a3ea26666",
"created_at": 1787693945.842374,
"updated_at": 1787693945.842374,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "90c2820e-e781-49e2-b9be-da2b4790f642",
"created_at": 1787693945.610468,
"updated_at": 1787693945.610468,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"label": "Residential Lease",
"is_lease": true,
"order": 0,
"required_roles": [
{
"title": "Tenant",
"checklist_types": [
"Offer",
"Buying"
],
"transaction_type": [
"Lease"
],
"role": "Tenant",
"type": "deal_role_definition"
},
{
"title": "Landlord",
"checklist_types": [
"Selling"
],
"transaction_type": [
"Lease"
],
"role": "Landlord",
"type": "deal_role_definition"
}
],
"optional_roles": [
{
"title": "Title",
"checklist_types": [
"Offer",
"Buying"
],
"transaction_type": [
"Sale"
],
"role": "Title",
"type": "deal_role_definition"
}
],
"type": "brand_property_type",
"checklists": [
{
"id": "297110e7-f8de-42dd-ba22-2dac06ad7431",
"created_at": 1787693944.819289,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642",
"checklist_type": "Selling",
"inbox": "b18e2651-eed9-44c1-aa1b-d6e271db1dd0",
"type": "brand_checklist",
"tasks": null
},
{
"id": "9db20df5-33e1-4104-8b30-cb05f2017114",
"created_at": 1787693944.819289,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642",
"checklist_type": "Buying",
"inbox": "c5e807f0-cfcf-4547-b4b9-a415575392f3",
"type": "brand_checklist",
"tasks": null
},
{
"id": "16d4c585-bd8d-4fc2-b849-43923174204c",
"created_at": 1787693944.819289,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642",
"checklist_type": "Offer",
"inbox": "c5e807f0-cfcf-4547-b4b9-a415575392f3",
"type": "brand_checklist",
"tasks": null
}
]
},
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": false,
"email": "[email protected]"
}
}Delete a deal ¶
Delete a dealDELETE/deals/:id
Example URI
DELETE /deals/:id
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Response
204Add a bunch of roles ¶
Add a bunch of rolesPOST/deals/:id/roles
Example URI
POST /deals/:id/roles
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
{
"roles": [
{
"email": "[email protected]",
"role": "BuyerAgent",
"commission_percentage": 3,
"company_title": "ACME",
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"office_address": {
"house_num": "11687",
"name": "Bellagio",
"suftype": "Rd",
"city": "Los Angeles",
"state": "CA",
"country": "USA",
"postcode": "90049"
},
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
{
"id": "c74ddd9c-d6ee-4a41-84f1-c0f9e505d86e",
"created_at": 1787693946.393867,
"updated_at": 1787693946.393867,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "SellerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"info": {
"count": 2,
"total": 0
}
}Update a role ¶
Update a rolePUT/deals/:id/roles/:rid
Example URI
PUT /deals/:id/roles/:rid
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- rid
string(required) Example: 7fa99ab9-7b0b-4708-85c3-f00b8a65453d
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d"
}Response
200Body
{
"code": "OK",
"data": {
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
}
}Set listing for a deal ¶
Set listing for a dealPATCH/deals/:id/listing
Example URI
PATCH /deals/:id/listing
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "57c418d8-e142-44ed-b452-23250a8d8818",
"searchable": "'dalla':1",
"deleted_at": null
},
"county": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "county",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "36c3b6e4-eeeb-4f74-be3f-1455710efba2",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"full_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "full_address",
"text": "5020 Junius Street Dallas, TX 75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "7e96f472-7e28-437f-afeb-f31e6af3ccc8",
"searchable": "'5020':1 '75214':6 'dalla':4 'junius':2 'street':3 'tx':5",
"deleted_at": null
},
"list_date": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_date",
"text": null,
"number": null,
"date": 1425189600,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a803ee0c-7cfd-4947-83a1-cde6eb647a54",
"searchable": null,
"deleted_at": null
},
"list_price": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_price",
"text": null,
"number": 498000,
"date": null,
"data_type": "Number",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4e710a77-a710-4eab-80ea-9357dbd422b5",
"searchable": "'498000':1",
"deleted_at": null
},
"listing_status": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "listing_status",
"text": "Sold",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "af37e817-7cee-4813-99e7-1e080d64f882",
"searchable": "'sold':1",
"deleted_at": null
},
"lot_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "lot_number",
"text": "14",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "d5f53be3-92b5-45b3-9737-9ac13a32f774",
"searchable": "'14':1",
"deleted_at": null
},
"mls_area_major": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_major",
"text": "DALLAS EAST (12)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "dff917e4-93bb-4ff5-9935-8fb7eb49e90a",
"searchable": "'12':3 'dalla':1 'east':2",
"deleted_at": null
},
"mls_area_minor": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_minor",
"text": "EAST DALLAS (11)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "9ddca0f1-d2f9-4360-b2cc-2855b4508c4d",
"searchable": "'11':3 'dalla':2 'east':1",
"deleted_at": null
},
"mls_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_number",
"text": "13103256",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "38fc0439-e5f4-4e8d-80cb-35b645211900",
"searchable": "'13103256':1",
"deleted_at": null
},
"photo": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "photo",
"text": "http://cdn.rechat.co/52656495.jpg",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "65418359-2080-4b2c-9591-9c0654e2b61c",
"searchable": "'/52656495.jpg':3 'cdn.rechat.co':2 'cdn.rechat.co/52656495.jpg':1",
"deleted_at": null
},
"postal_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "postal_code",
"text": "75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a571b984-6140-4eba-9e1c-bf7bd942578d",
"searchable": "'75214':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"state": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state",
"text": "Texas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "bfe9e1e8-1b36-41ca-890f-90fd4cafdc34",
"searchable": "'texa':1",
"deleted_at": null
},
"state_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state_code",
"text": "TX",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "262c7332-7bd8-4ea7-b4a3-652f5aba1609",
"searchable": "'tx':1",
"deleted_at": null
},
"street_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_address",
"text": "5020 Junius Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "01fb7225-e07b-48f6-8b97-5009612dc7f6",
"searchable": "'5020':1 'junius':2 'street':3",
"deleted_at": null
},
"street_dir_prefix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_dir_prefix",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "2891b6a2-1b31-4798-a4d7-b3a874705174",
"searchable": "",
"deleted_at": null
},
"street_name": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_name",
"text": "Junius",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "067001a7-d083-46d7-aa58-3ac398ffb836",
"searchable": "'junius':1",
"deleted_at": null
},
"street_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_number",
"text": "5020",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4c48f8bd-74a3-40f1-a203-1a8e242901d0",
"searchable": "'5020':1",
"deleted_at": null
},
"street_suffix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_suffix",
"text": "Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "8565c808-721b-417c-baaa-c308c2cd921c",
"searchable": "'street':1",
"deleted_at": null
},
"subdivision": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "subdivision",
"text": "Munger Place",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e0d9f6af-8cbf-4a67-b3e2-e1026c4396b3",
"searchable": "'munger':1 'place':2",
"deleted_at": null
},
"unit_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "unit_number",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e69c79cf-7e08-4106-bd39-e7774bf6801d",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Change property type of a deal ¶
Change property type of a dealPATCH/deals/:id/property_type
Example URI
PATCH /deals/:id/property_type
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642"
}Response
200Body
{
"code": "OK",
"data": {
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "5020 Junius Street",
"property_type": {
"id": "90c2820e-e781-49e2-b9be-da2b4790f642",
"created_at": 1787693945.610468,
"updated_at": 1787693945.610468,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"label": "Residential Lease",
"is_lease": true,
"order": 0,
"required_roles": [
{
"title": "Tenant",
"checklist_types": [
"Offer",
"Buying"
],
"transaction_type": [
"Lease"
],
"role": "Tenant",
"type": "deal_role_definition"
},
{
"title": "Landlord",
"checklist_types": [
"Selling"
],
"transaction_type": [
"Lease"
],
"role": "Landlord",
"type": "deal_role_definition"
}
],
"optional_roles": [
{
"title": "Title",
"checklist_types": [
"Offer",
"Buying"
],
"transaction_type": [
"Sale"
],
"role": "Title",
"type": "deal_role_definition"
}
],
"type": "brand_property_type",
"checklists": [
{
"id": "297110e7-f8de-42dd-ba22-2dac06ad7431",
"created_at": 1787693944.819289,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642",
"checklist_type": "Selling",
"inbox": "b18e2651-eed9-44c1-aa1b-d6e271db1dd0",
"type": "brand_checklist",
"tasks": null
},
{
"id": "9db20df5-33e1-4104-8b30-cb05f2017114",
"created_at": 1787693944.819289,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642",
"checklist_type": "Buying",
"inbox": "c5e807f0-cfcf-4547-b4b9-a415575392f3",
"type": "brand_checklist",
"tasks": null
},
{
"id": "16d4c585-bd8d-4fc2-b849-43923174204c",
"created_at": 1787693944.819289,
"deleted_at": null,
"brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642",
"checklist_type": "Offer",
"inbox": "c5e807f0-cfcf-4547-b4b9-a415575392f3",
"type": "brand_checklist",
"tasks": null
}
]
},
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "57c418d8-e142-44ed-b452-23250a8d8818",
"searchable": "'dalla':1",
"deleted_at": null
},
"county": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "county",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "36c3b6e4-eeeb-4f74-be3f-1455710efba2",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"full_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "full_address",
"text": "5020 Junius Street Dallas, TX 75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "7e96f472-7e28-437f-afeb-f31e6af3ccc8",
"searchable": "'5020':1 '75214':6 'dalla':4 'junius':2 'street':3 'tx':5",
"deleted_at": null
},
"list_date": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_date",
"text": null,
"number": null,
"date": 1425189600,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a803ee0c-7cfd-4947-83a1-cde6eb647a54",
"searchable": null,
"deleted_at": null
},
"list_price": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "list_price",
"text": null,
"number": 498000,
"date": null,
"data_type": "Number",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4e710a77-a710-4eab-80ea-9357dbd422b5",
"searchable": "'498000':1",
"deleted_at": null
},
"listing_status": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "listing_status",
"text": "Sold",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "af37e817-7cee-4813-99e7-1e080d64f882",
"searchable": "'sold':1",
"deleted_at": null
},
"lot_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "lot_number",
"text": "14",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "d5f53be3-92b5-45b3-9737-9ac13a32f774",
"searchable": "'14':1",
"deleted_at": null
},
"mls_area_major": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_major",
"text": "DALLAS EAST (12)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "dff917e4-93bb-4ff5-9935-8fb7eb49e90a",
"searchable": "'12':3 'dalla':1 'east':2",
"deleted_at": null
},
"mls_area_minor": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_area_minor",
"text": "EAST DALLAS (11)",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "9ddca0f1-d2f9-4360-b2cc-2855b4508c4d",
"searchable": "'11':3 'dalla':2 'east':1",
"deleted_at": null
},
"mls_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "mls_number",
"text": "13103256",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "38fc0439-e5f4-4e8d-80cb-35b645211900",
"searchable": "'13103256':1",
"deleted_at": null
},
"photo": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "photo",
"text": "http://cdn.rechat.co/52656495.jpg",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "65418359-2080-4b2c-9591-9c0654e2b61c",
"searchable": "'/52656495.jpg':3 'cdn.rechat.co':2 'cdn.rechat.co/52656495.jpg':1",
"deleted_at": null
},
"postal_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "postal_code",
"text": "75214",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "a571b984-6140-4eba-9e1c-bf7bd942578d",
"searchable": "'75214':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"state": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state",
"text": "Texas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "bfe9e1e8-1b36-41ca-890f-90fd4cafdc34",
"searchable": "'texa':1",
"deleted_at": null
},
"state_code": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "state_code",
"text": "TX",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "262c7332-7bd8-4ea7-b4a3-652f5aba1609",
"searchable": "'tx':1",
"deleted_at": null
},
"street_address": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_address",
"text": "5020 Junius Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "01fb7225-e07b-48f6-8b97-5009612dc7f6",
"searchable": "'5020':1 'junius':2 'street':3",
"deleted_at": null
},
"street_dir_prefix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_dir_prefix",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "2891b6a2-1b31-4798-a4d7-b3a874705174",
"searchable": "",
"deleted_at": null
},
"street_name": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_name",
"text": "Junius",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "067001a7-d083-46d7-aa58-3ac398ffb836",
"searchable": "'junius':1",
"deleted_at": null
},
"street_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_number",
"text": "5020",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "4c48f8bd-74a3-40f1-a203-1a8e242901d0",
"searchable": "'5020':1",
"deleted_at": null
},
"street_suffix": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "street_suffix",
"text": "Street",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "8565c808-721b-417c-baaa-c308c2cd921c",
"searchable": "'street':1",
"deleted_at": null
},
"subdivision": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "subdivision",
"text": "Munger Place",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e0d9f6af-8cbf-4a67-b3e2-e1026c4396b3",
"searchable": "'munger':1 'place':2",
"deleted_at": null
},
"unit_number": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "unit_number",
"text": "",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "MLS",
"definition": "e69c79cf-7e08-4106-bd39-e7774bf6801d",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Add Context to a deal ¶
Add Context to a dealPOST/deals/:id/context
Example URI
POST /deals/:id/context
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
{
"context": [
{
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"value": "2017/12/06"
},
{
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Set approval status for a context ¶
Set approval status for a contextPATCH/deals/:id/context/:cid/approved
Example URI
PATCH /deals/:id/context/:cid/approved
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- cid
string(required) Example: 4cafdf1c-1747-4f64-86e3-ebbe341aa1ae
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_at": 1787693945.842282,
"updated_at": 1787693945.842282,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86",
"searchable": "'convent':1",
"deleted_at": null
},
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": null,
"source": "PropertyType",
"definition": "77caf735-c31c-4c38-b644-aa4ceac33091",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": "2026-08-25T21:39:04.819289+00:00",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_at": "2026-08-25T21:39:06.081753+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"source": "Provided",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Get history for a deal context on a deal ¶
Get history for a deal context on a dealGET/deals/:id/context/:cname
Example URI
GET /deals/:id/context/:cname
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": 1787693944.819289,
"approved_at": 1787693946.081753,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32"
}
],
"info": {
"count": 1,
"total": 0
}
}Add roles to a deal ¶
Add roles to a dealPOST/deals/:id/roles
Example URI
POST /deals/:id/roles
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
{
"roles": [
{
"email": "[email protected]",
"role": "BuyerAgent",
"commission_percentage": 3,
"company_title": "ACME",
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"office_address": {
"house_num": "11687",
"name": "Bellagio",
"suftype": "Rd",
"city": "Los Angeles",
"state": "CA",
"country": "USA",
"postcode": "90049"
},
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "7fa99ab9-7b0b-4708-85c3-f00b8a65453d",
"created_at": 1787693946.390927,
"updated_at": 1787693946.390927,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "BuyerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
{
"id": "c74ddd9c-d6ee-4a41-84f1-c0f9e505d86e",
"created_at": 1787693946.393867,
"updated_at": 1787693946.393867,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"role": "SellerAgent",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"info": {
"count": 2,
"total": 0
}
}Delete a role ¶
Delete a roleDELETE/deals/:id/roles/:rid
Example URI
DELETE /deals/:id/roles/:rid
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- rid
string(required) Example: 7fa99ab9-7b0b-4708-85c3-f00b8a65453d
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "90c2820e-e781-49e2-b9be-da2b4790f642"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "648c014b-c52f-4bce-98db-68c087b32b32",
"created_at": 1787693944.819289,
"updated_at": 1787693944.819289,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"order": 1,
"origin": "16d4c585-bd8d-4fc2-b849-43923174204c",
"terminated_at": null,
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": false,
"is_terminated": false,
"tasks": null,
"context": {},
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"inbox": "c5e807f0-cfcf-4547-b4b9-a415575392f3",
"is_active_offer": true
}
}Update a checklist ¶
Update a checklistPUT/deals/:id/checklists/:cid
Example URI
PUT /deals/:id/checklists/:cid
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- cid
string(required) Example: 648c014b-c52f-4bce-98db-68c087b32b32
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "648c014b-c52f-4bce-98db-68c087b32b32"
}Response
200Body
{
"code": "OK",
"data": {
"id": "648c014b-c52f-4bce-98db-68c087b32b32",
"created_at": 1787693944.819289,
"updated_at": 1787693944.819289,
"deleted_at": null,
"deactivated_at": "2026-08-25T21:39:10.508Z",
"title": "Updated Checklist 1",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"order": 3,
"origin": "16d4c585-bd8d-4fc2-b849-43923174204c",
"terminated_at": "2026-08-25T21:39:10.508Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "a0a5bd72-215c-4291-9832-50189ad5b4d5",
"created_at": 1787693947.009179,
"updated_at": 1787693950.405585,
"room": {
"type": "room",
"id": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6",
"title": "5020 Junius Street: Test Title",
"created_at": 1787693946.998512,
"updated_at": 1787693950.113641,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4eeb0209-ba5f-4ab5-8828-9e9d02af7a85",
"last_revision": "995cd3e5-dbd0-4fdd-885a-ff601eda8055",
"state": "Fair",
"created_at": 1787693948.915002,
"updated_at": 1787693949.3182,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"formstack_id": null,
"author": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "559b9a04-6687-402e-81b1-3ed30bb4ccff",
"created_at": 1787693949.338012,
"updated_at": 1787693949.338012,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780349340&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QIikOSX6aTE-dA0YwS18FJ2JzajascfCewaJTjv4kSxma9JWcv-18Lq-33pr41v8Shl-PLIRW~opfe3dIbdRPby~NHvbSDxd2WbF480azH7U97cr2wYSqQQLWcdrSwv3CJi78K4hFsf9pENUsvVttYK0hftqr~dlnuYvsXOoBmF8l3qU-7BM9AiS5hI2vSzw0gxH6hf6QTMtiv45UHS0DELxuo3nAjPjTf1AOmy~QzDP16WeNo7G-F8bvYIxS0nL61nYXxKiWMg2RX1lgXaSeJsQkMrKch-w1dtjf7aYej45EMfC48SlEqimU~6HtkhEAYiRAi7Yesa~0dI4s3J4PA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "67874c0f-3526-4823-bca6-3bec9fca4c37",
"created_at": 1787693949.653892,
"type": "review",
"status": "Declined",
"updated_at": 1787693949.656195
},
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": null,
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/submission.pdf?hash=jFzZqXtHACj1io3SRjEnU%2F5rhLuYdxmLXz9bY4RaMiDEDnR%2FRojFv%2BUdnXoVB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pXyiAux1dkIATg%3D%3D"
}
],
"context": {
"financing_type": {
"id": "c841f5e0-bae1-4511-8df9-df3d4f956a81",
"type": "deal_context_item",
"created_at": 1787693944.819289,
"approved_at": null,
"date": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"data_type": "Text",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"definition": "9b2d8195-bc60-49e0-adc5-8b2b1f5deb86"
},
"review_date": {
"id": "4cafdf1c-1747-4f64-86e3-ebbe341aa1ae",
"type": "deal_context_item",
"created_at": 1787693944.819289,
"approved_at": 1787693946.081753,
"date": 1512518400,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"approved_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"definition": "da336ef3-041f-47c8-9e4c-2c489b767431"
}
},
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"inbox": "c5e807f0-cfcf-4547-b4b9-a415575392f3",
"is_active_offer": false
}
}Get a single task ¶
Get a single taskGET/tasks/:id
Example URI
GET /tasks/:id
URI Parameters
- task
string(required) Example: a0a5bd72-215c-4291-9832-50189ad5b4d5
Response
200Body
{
"code": "OK",
"data": {
"id": "a0a5bd72-215c-4291-9832-50189ad5b4d5",
"created_at": 1787693947.009179,
"updated_at": 1787693948.976862,
"room": {
"type": "room",
"id": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6",
"title": "5020 Junius Street: Test Title",
"created_at": 1787693946.998512,
"updated_at": 1787693949.4975,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4eeb0209-ba5f-4ab5-8828-9e9d02af7a85",
"last_revision": "995cd3e5-dbd0-4fdd-885a-ff601eda8055",
"state": "Fair",
"created_at": 1787693948.915002,
"updated_at": 1787693949.3182,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"formstack_id": null,
"author": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "559b9a04-6687-402e-81b1-3ed30bb4ccff",
"created_at": 1787693949.338012,
"updated_at": 1787693949.338012,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780349340&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QIikOSX6aTE-dA0YwS18FJ2JzajascfCewaJTjv4kSxma9JWcv-18Lq-33pr41v8Shl-PLIRW~opfe3dIbdRPby~NHvbSDxd2WbF480azH7U97cr2wYSqQQLWcdrSwv3CJi78K4hFsf9pENUsvVttYK0hftqr~dlnuYvsXOoBmF8l3qU-7BM9AiS5hI2vSzw0gxH6hf6QTMtiv45UHS0DELxuo3nAjPjTf1AOmy~QzDP16WeNo7G-F8bvYIxS0nL61nYXxKiWMg2RX1lgXaSeJsQkMrKch-w1dtjf7aYej45EMfC48SlEqimU~6HtkhEAYiRAi7Yesa~0dI4s3J4PA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": null,
"required": false,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/submission.pdf?hash=jFzZqXtHACj1io3SRjEnU%2F5rhLuYdxmLXz9bY4RaMiDEDnR%2FRojFv%2BUdnXoVB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pX2rAu9zfkIATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"is_deletable": true,
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"room": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6"
}Response
200Body
{
"code": "OK",
"data": {
"id": "a0a5bd72-215c-4291-9832-50189ad5b4d5",
"created_at": 1787693947.009179,
"updated_at": 1787693947.009179,
"room": {
"type": "room",
"id": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6",
"title": "5020 Junius Street: Test Title",
"created_at": 1787693946.998512,
"updated_at": 1787693947.080949,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": null,
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/submission.pdf?hash=jFzZqXtHACj1io3SRjEnU%2F5rhLuYdxmLXz9bY4RaMiDEDnR%2FRojFv%2BUdnXoVB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pX2lAutzdkIATg%3D%3D"
}
}Set form on a task ¶
Set form on a taskPUT/tasks/:task/submission
Example URI
PUT /tasks/:task/submission
URI Parameters
- task
string(required) Example: a0a5bd72-215c-4291-9832-50189ad5b4d5
Request
Body
{
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"state": "Fair",
"pdf": "https://s3-us-west-2.amazonaws.com/rechat-forms/2672324.pdf",
"values": {
"Form1": "11112 New Orleans Drive"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "4eeb0209-ba5f-4ab5-8828-9e9d02af7a85",
"last_revision": "a4144e99-a9ce-4e4a-9049-796461367647",
"state": "Fair",
"created_at": 1787693948.915002,
"updated_at": 1787693949.124279,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"formstack_id": null,
"author": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "5330a275-2fe2-48cb-a9cb-e3436da71102",
"created_at": 1787693949.142138,
"updated_at": 1787693949.142138,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/678dc480-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/678dc480-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780349145&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QhmWjFXes9Iihl7sMhwpeoWY2qTW~stInt8oQC0v4L7GyIS~aCXiAN8XQ9qDfB~-SW9L8i83hpYjuFvv7-dAZFJVdT2Cn7h5HNuCrsFfrBRNxQRWNSAFTkPpK62Eez14dpzufiJIEgs80a3DnflpUnKg8g26Hm0j~J0zBlQHpRvgpLlTj4KdJ4ko6VRFLddj50pj1r22f-vMTYcV47cVErssXHfWIZc9ihk-Cc-FCZPEprlHU-GOl5ySg56gPYzAzxM1G2BGl0RzcgoMhZ8s3YtI3HKeZJ7ZQkwic4S3crNHHmbgR5-YgIJ68VxwKHpfYzuIA1~Q6HUGVa5pl8ZjXw__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 2
}
}Get a form revision of a task ¶
Get a form revision of a taskGET/tasks/:task/submission/:revision
Example URI
GET /tasks/:task/submission/:revision
URI Parameters
- task
string(required) Example: a0a5bd72-215c-4291-9832-50189ad5b4d5- revision
string(required) Example: a4144e99-a9ce-4e4a-9049-796461367647
Response
200Body
{
"code": "OK",
"data": {
"id": "a4144e99-a9ce-4e4a-9049-796461367647",
"submission": "4eeb0209-ba5f-4ab5-8828-9e9d02af7a85",
"created_at": 1787693948.915002,
"updated_at": 1787693949.124279,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"author": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "5330a275-2fe2-48cb-a9cb-e3436da71102"
}
}Set review on a task ¶
Set review on a taskPUT/tasks/:task/review
Example URI
PUT /tasks/:task/review
URI Parameters
- task
string(required) Example: a0a5bd72-215c-4291-9832-50189ad5b4d5
Request
Body
{
"status": "Declined",
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c"
}Response
200Body
{
"code": "OK",
"data": {
"id": "a0a5bd72-215c-4291-9832-50189ad5b4d5",
"created_at": 1787693947.009179,
"updated_at": 1787693949.663954,
"room": {
"type": "room",
"id": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6",
"title": "5020 Junius Street: Test Title",
"created_at": 1787693946.998512,
"updated_at": 1787693949.704915,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4eeb0209-ba5f-4ab5-8828-9e9d02af7a85",
"last_revision": "995cd3e5-dbd0-4fdd-885a-ff601eda8055",
"state": "Fair",
"created_at": 1787693948.915002,
"updated_at": 1787693949.3182,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"formstack_id": null,
"author": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "559b9a04-6687-402e-81b1-3ed30bb4ccff",
"created_at": 1787693949.338012,
"updated_at": 1787693949.338012,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780349340&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QIikOSX6aTE-dA0YwS18FJ2JzajascfCewaJTjv4kSxma9JWcv-18Lq-33pr41v8Shl-PLIRW~opfe3dIbdRPby~NHvbSDxd2WbF480azH7U97cr2wYSqQQLWcdrSwv3CJi78K4hFsf9pENUsvVttYK0hftqr~dlnuYvsXOoBmF8l3qU-7BM9AiS5hI2vSzw0gxH6hf6QTMtiv45UHS0DELxuo3nAjPjTf1AOmy~QzDP16WeNo7G-F8bvYIxS0nL61nYXxKiWMg2RX1lgXaSeJsQkMrKch-w1dtjf7aYej45EMfC48SlEqimU~6HtkhEAYiRAi7Yesa~0dI4s3J4PA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "67874c0f-3526-4823-bca6-3bec9fca4c37",
"created_at": 1787693949.653892,
"type": "review",
"status": "Declined",
"updated_at": 1787693949.656195
},
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": null,
"required": false,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/submission.pdf?hash=jFzZqXtHACj1io3SRjEnU%2F5rhLuYdxmLXz9bY4RaMiDEDnR%2FRojFv%2BUdnXoVB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pX2rAuFxfEIATg%3D%3D"
}
}Set attention status on a task ¶
Set attention status on a taskPATCH/tasks/:task/attention_requested
Example URI
PATCH /tasks/:task/attention_requested
URI Parameters
- task
string(required) Example: a0a5bd72-215c-4291-9832-50189ad5b4d5
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "a0a5bd72-215c-4291-9832-50189ad5b4d5",
"created_at": 1787693947.009179,
"updated_at": 1787693950.157257,
"room": {
"type": "room",
"id": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6",
"title": "5020 Junius Street: Test Title",
"created_at": 1787693946.998512,
"updated_at": 1787693950.113641,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4eeb0209-ba5f-4ab5-8828-9e9d02af7a85",
"last_revision": "995cd3e5-dbd0-4fdd-885a-ff601eda8055",
"state": "Fair",
"created_at": 1787693948.915002,
"updated_at": 1787693949.3182,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"formstack_id": null,
"author": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "559b9a04-6687-402e-81b1-3ed30bb4ccff",
"created_at": 1787693949.338012,
"updated_at": 1787693949.338012,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/67abacc0-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780349340&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QIikOSX6aTE-dA0YwS18FJ2JzajascfCewaJTjv4kSxma9JWcv-18Lq-33pr41v8Shl-PLIRW~opfe3dIbdRPby~NHvbSDxd2WbF480azH7U97cr2wYSqQQLWcdrSwv3CJi78K4hFsf9pENUsvVttYK0hftqr~dlnuYvsXOoBmF8l3qU-7BM9AiS5hI2vSzw0gxH6hf6QTMtiv45UHS0DELxuo3nAjPjTf1AOmy~QzDP16WeNo7G-F8bvYIxS0nL61nYXxKiWMg2RX1lgXaSeJsQkMrKch-w1dtjf7aYej45EMfC48SlEqimU~6HtkhEAYiRAi7Yesa~0dI4s3J4PA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "67874c0f-3526-4823-bca6-3bec9fca4c37",
"created_at": 1787693949.653892,
"type": "review",
"status": "Declined",
"updated_at": 1787693949.656195
},
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-08-25T21:39:10.157Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/submission.pdf?hash=jFzZqXtHACj1io3SRjEnU%2F5rhLuYdxmLXz9bY4RaMiDEDnR%2FRojFv%2BUdnXoVB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pXyiAutzdkIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: 29674745-d03a-4c60-9e42-6b1ace448412
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "29674745-d03a-4c60-9e42-6b1ace448412",
"created_at": 1787693947.290733,
"updated_at": 1787693947.80991,
"room": {
"type": "room",
"id": "8d39af8a-1450-4be8-a7af-c908d5d6b783",
"title": "5020 Junius Street: Another Task",
"created_at": 1787693947.274338,
"updated_at": 1787693947.389797,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": null,
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/29674745-d03a-4c60-9e42-6b1ace448412/submission.pdf?hash=jFzZqXtHACj12YSFRGd0UPlr0rqedRmLDjBaY4QHNSDEDSZ%2FH9LB7%2BRHnS8SB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pX2lAuF2fkIATg%3D%3D"
}
}Update a bunch of tasks ¶
Update a bunch of tasksPUT/deals/:id/tasks
Example URI
PUT /deals/:id/tasks
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
[
{
"id": "a0a5bd72-215c-4291-9832-50189ad5b4d5",
"title": "Bulk Test Title"
},
{
"id": "29674745-d03a-4c60-9e42-6b1ace448412",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "a0a5bd72-215c-4291-9832-50189ad5b4d5",
"created_at": 1787693947.009179,
"updated_at": 1787693947.909126,
"room": {
"type": "room",
"id": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6",
"title": "5020 Junius Street: Test Title",
"created_at": 1787693946.998512,
"updated_at": 1787693947.68992,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": null,
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/submission.pdf?hash=jFzZqXtHACj1io3SRjEnU%2F5rhLuYdxmLXz9bY4RaMiDEDnR%2FRojFv%2BUdnXoVB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pX2qAul7dkIATg%3D%3D"
},
{
"id": "29674745-d03a-4c60-9e42-6b1ace448412",
"created_at": 1787693947.290733,
"updated_at": 1787693948.004074,
"room": {
"type": "room",
"id": "8d39af8a-1450-4be8-a7af-c908d5d6b783",
"title": "5020 Junius Street: Another Task",
"created_at": 1787693947.274338,
"updated_at": 1787693947.959069,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ae8e7798-9398-49fe-8fd8-5a48f97b5f6c": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "ceab0461-215f-46aa-a7cd-f2495b0090df",
"checklist": "648c014b-c52f-4bce-98db-68c087b32b32",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-08-25T21:39:08.004Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "c5eb2815-7b04-4be4-a281-1cb603098e68",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/29674745-d03a-4c60-9e42-6b1ace448412/submission.pdf?hash=jFzZqXtHACj12YSFRGd0UPlr0rqedRmLDjBaY4QHNSDEDSZ%2FH9LB7%2BRHnS8SB2inxE%2BVOb1Ni5IcEvhE4k3smhzAS7MCcp5ZxgG06x49Z1knmsjj1iM%2BKQlhPKoeYPGdRmKCTXNE1lZyWqV1aA6lJG7Pu8s8pX2qAul7dkIATg%3D%3D"
}
],
"info": {
"count": 2,
"total": 0
}
}Record activity on timeline of a task ¶
Record activity on timeline of a taskPOST/tasks/:task/timeline
Example URI
POST /tasks/:task/timeline
URI Parameters
- task
string(required) Example: a0a5bd72-215c-4291-9832-50189ad5b4d5
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "5330a275-2fe2-48cb-a9cb-e3436da71102"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5d09a3d1-5814-4d1f-93ad-527ad14028f4",
"reference": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"reference_type": "User",
"created_at": 1787693949.48474,
"updated_at": 1787693949.48474,
"deleted_at": null,
"object": {
"id": "5330a275-2fe2-48cb-a9cb-e3436da71102",
"created_at": 1787693949.142138,
"updated_at": 1787693949.142138,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/678dc480-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/a0a5bd72-215c-4291-9832-50189ad5b4d5/678dc480-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780349145&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QhmWjFXes9Iihl7sMhwpeoWY2qTW~stInt8oQC0v4L7GyIS~aCXiAN8XQ9qDfB~-SW9L8i83hpYjuFvv7-dAZFJVdT2Cn7h5HNuCrsFfrBRNxQRWNSAFTkPpK62Eez14dpzufiJIEgs80a3DnflpUnKg8g26Hm0j~J0zBlQHpRvgpLlTj4KdJ4ko6VRFLddj50pj1r22f-vMTYcV47cVErssXHfWIZc9ihk-Cc-FCZPEprlHU-GOl5ySg56gPYzAzxM1G2BGl0RzcgoMhZ8s3YtI3HKeZJ7ZQkwic4S3crNHHmbgR5-YgIJ68VxwKHpfYzuIA1~Q6HUGVa5pl8ZjXw__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"action": "UserViewedFile",
"is_visible": true,
"brand": null,
"created_by": null,
"description": null,
"type": "activity"
}
}Post message to a task room ¶
Post message to a task roomPOST/tasks/:task/messages
Example URI
POST /tasks/:task/messages
URI Parameters
- task
string(required) Example: a0a5bd72-215c-4291-9832-50189ad5b4d5
Request
Body
{
"comment": "Comment",
"author": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"room": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "11aa81c3-8968-43c3-bdef-8b91a206c019",
"id": "11aa81c3-8968-43c3-bdef-8b91a206c019",
"comment": "Comment",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+12193631038",
"created_at": 1787693944.838625,
"id": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1787693944.819289,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "63fc7d0f-884d-4005-9274-5f726c2a4b20",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "4:39 PM - Tuesday Aug 25, 2026",
"push_allowed": true,
"agents": [
{
"id": "52de523c-8318-4adb-bb23-46cdf9f224f6",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1052709756",
"updated_at": 1787693944.991788,
"deleted_at": null,
"created_at": 1787693944.991788,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "cbce1035-783a-4506-8b2e-dc0fcae7c337",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1787693950.639966,
"updated_at": 1787693950.639966,
"room": "83d3ddcb-b3c2-44ea-a696-30ffd7b1ade6",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": null,
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
}
}Delete a task ¶
Delete a taskDELETE/tasks/:task
Example URI
DELETE /tasks/:task
URI Parameters
- task
string(required) Example: 29674745-d03a-4c60-9e42-6b1ace448412
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Response
200Body
{
"code": "OK",
"data": {
"id": "52dc6998-41fa-4473-a1df-96d5a81c0f3e",
"created_at": 1787693951.160709,
"updated_at": 1787693951.160709,
"deleted_at": null,
"gallery": "65986bb2-a0cd-11f1-85f5-1a8a3ea26666",
"name": null,
"order": 0,
"file": {
"id": "5f22546b-601b-4282-9f66-c72adb2edb6b",
"created_at": 1787693951.156148,
"updated_at": 1787693951.156148,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "c5eb2815-7b04-4be4-a281-1cb603098e68/68c29b00-a0cd-11f1-8f39-f7b7c39ebedd.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/c5eb2815-7b04-4be4-a281-1cb603098e68/68c29b00-a0cd-11f1-8f39-f7b7c39ebedd.png",
"preview_url": "https://test.cloudfront.net/c5eb2815-7b04-4be4-a281-1cb603098e68/68c29b00-a0cd-11f1-8f39-f7b7c39ebedd.png",
"mime": "image/png"
},
"type": "gallery_item"
}
}Update gallery item ¶
Update gallery itemPUT/deals/:id/gallery/items/:iid
Example URI
PUT /deals/:id/gallery/items/:iid
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- iid
string(required) Example: 52dc6998-41fa-4473-a1df-96d5a81c0f3e
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "5f22546b-601b-4282-9f66-c72adb2edb6b"
}Response
200Body
{
"code": "OK",
"data": {
"id": "52dc6998-41fa-4473-a1df-96d5a81c0f3e",
"created_at": 1787693951.160709,
"updated_at": 1787693944.819289,
"deleted_at": null,
"gallery": "65986bb2-a0cd-11f1-85f5-1a8a3ea26666",
"name": "Updated Name",
"order": 2,
"file": {
"id": "5f22546b-601b-4282-9f66-c72adb2edb6b",
"created_at": 1787693951.156148,
"updated_at": 1787693951.156148,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "c5eb2815-7b04-4be4-a281-1cb603098e68/68c29b00-a0cd-11f1-8f39-f7b7c39ebedd.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/c5eb2815-7b04-4be4-a281-1cb603098e68/68c29b00-a0cd-11f1-8f39-f7b7c39ebedd.png",
"preview_url": "https://test.cloudfront.net/c5eb2815-7b04-4be4-a281-1cb603098e68/68c29b00-a0cd-11f1-8f39-f7b7c39ebedd.png",
"mime": "image/png"
},
"type": "gallery_item"
}
}Update gallery item's file ¶
Update gallery item's filePATCH/deals/:id/gallery/items/:iid/file
Example URI
PATCH /deals/:id/gallery/items/:iid/file
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68- iid
string(required) Example: 52dc6998-41fa-4473-a1df-96d5a81c0f3e
Response
200Body
{
"code": "OK",
"data": {
"id": "52dc6998-41fa-4473-a1df-96d5a81c0f3e",
"created_at": 1787693951.160709,
"updated_at": 1787693944.819289,
"deleted_at": null,
"gallery": "65986bb2-a0cd-11f1-85f5-1a8a3ea26666",
"name": "Updated Name",
"order": 2,
"file": {
"id": "5ffb5d65-f681-4cd1-a021-84d416fb1358",
"created_at": 1787693951.231292,
"updated_at": 1787693951.231292,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "c5eb2815-7b04-4be4-a281-1cb603098e68/68ce33c0-a0cd-11f1-8f39-f7b7c39ebedd.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/c5eb2815-7b04-4be4-a281-1cb603098e68/68ce33c0-a0cd-11f1-8f39-f7b7c39ebedd.png?Expires=1787780351234&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=c-wTflHztM~NaA9~-RikuEm~biLVIYLIsWhxZMr2QSwpnemOjjHKlRKqQ~gkD1ThswoeFkp6vmY9itdGZgg4bwN9McPh4TqS4fK~DA6G7l38vL1YEDYJ16xkceQJMNWsMIM5iUNHmFz5pQMB~jZtW2RAIY1cLAPB82rIlylPNby~3QMKZ2skndktFNX7dx~KjekLmGveNeAhU--mDtP6WRgiqtBdaOfchIRFT6U39ReHVPrVSJSHP5pPGfFcNC2IxJ9sTvAxfjVcYCLUb3idcqDN6VV7mOK0pqIxGpuPGjsFb8fsZcSeH1xDl2rHJPSdhNxPcPLLtJ1jB-ldryCtww__",
"preview_url": "https://private-cdn.irish.rechat.com/c5eb2815-7b04-4be4-a281-1cb603098e68/68ce33c0-a0cd-11f1-8f39-f7b7c39ebedd.png?Expires=1787780351234&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=c-wTflHztM~NaA9~-RikuEm~biLVIYLIsWhxZMr2QSwpnemOjjHKlRKqQ~gkD1ThswoeFkp6vmY9itdGZgg4bwN9McPh4TqS4fK~DA6G7l38vL1YEDYJ16xkceQJMNWsMIM5iUNHmFz5pQMB~jZtW2RAIY1cLAPB82rIlylPNby~3QMKZ2skndktFNX7dx~KjekLmGveNeAhU--mDtP6WRgiqtBdaOfchIRFT6U39ReHVPrVSJSHP5pPGfFcNC2IxJ9sTvAxfjVcYCLUb3idcqDN6VV7mOK0pqIxGpuPGjsFb8fsZcSeH1xDl2rHJPSdhNxPcPLLtJ1jB-ldryCtww__",
"mime": "image/png"
},
"type": "gallery_item"
}
}Sort gallery items ¶
Sort gallery itemsPUT/deals/:id/gallery/items/sort
Example URI
PUT /deals/:id/gallery/items/sort
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
[
{
"id": "52dc6998-41fa-4473-a1df-96d5a81c0f3e",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "52dc6998-41fa-4473-a1df-96d5a81c0f3e",
"created_at": 1787693951.160709,
"updated_at": 1787693944.819289,
"deleted_at": 1787693944.819289,
"gallery": "65986bb2-a0cd-11f1-85f5-1a8a3ea26666",
"name": "Updated Name",
"order": 3,
"file": {
"id": "5ffb5d65-f681-4cd1-a021-84d416fb1358",
"created_at": 1787693951.231292,
"updated_at": 1787693951.231292,
"deleted_at": null,
"created_by": "ae8e7798-9398-49fe-8fd8-5a48f97b5f6c",
"path": "c5eb2815-7b04-4be4-a281-1cb603098e68/68ce33c0-a0cd-11f1-8f39-f7b7c39ebedd.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/c5eb2815-7b04-4be4-a281-1cb603098e68/68ce33c0-a0cd-11f1-8f39-f7b7c39ebedd.png?Expires=1787780351234&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=c-wTflHztM~NaA9~-RikuEm~biLVIYLIsWhxZMr2QSwpnemOjjHKlRKqQ~gkD1ThswoeFkp6vmY9itdGZgg4bwN9McPh4TqS4fK~DA6G7l38vL1YEDYJ16xkceQJMNWsMIM5iUNHmFz5pQMB~jZtW2RAIY1cLAPB82rIlylPNby~3QMKZ2skndktFNX7dx~KjekLmGveNeAhU--mDtP6WRgiqtBdaOfchIRFT6U39ReHVPrVSJSHP5pPGfFcNC2IxJ9sTvAxfjVcYCLUb3idcqDN6VV7mOK0pqIxGpuPGjsFb8fsZcSeH1xDl2rHJPSdhNxPcPLLtJ1jB-ldryCtww__",
"preview_url": "https://private-cdn.irish.rechat.com/c5eb2815-7b04-4be4-a281-1cb603098e68/68ce33c0-a0cd-11f1-8f39-f7b7c39ebedd.png?Expires=1787780351234&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=c-wTflHztM~NaA9~-RikuEm~biLVIYLIsWhxZMr2QSwpnemOjjHKlRKqQ~gkD1ThswoeFkp6vmY9itdGZgg4bwN9McPh4TqS4fK~DA6G7l38vL1YEDYJ16xkceQJMNWsMIM5iUNHmFz5pQMB~jZtW2RAIY1cLAPB82rIlylPNby~3QMKZ2skndktFNX7dx~KjekLmGveNeAhU--mDtP6WRgiqtBdaOfchIRFT6U39ReHVPrVSJSHP5pPGfFcNC2IxJ9sTvAxfjVcYCLUb3idcqDN6VV7mOK0pqIxGpuPGjsFb8fsZcSeH1xDl2rHJPSdhNxPcPLLtJ1jB-ldryCtww__",
"mime": "image/png"
},
"type": "gallery_item"
}
],
"info": {
"count": 1,
"total": 0
}
}Generate a Zip url for deal's gallery ¶
Generate a Zip url for deal's galleryPOST/deals/:id/gallery.zip
Example URI
POST /deals/:id/gallery.zip
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Request
Body
{
"items": [
"52dc6998-41fa-4473-a1df-96d5a81c0f3e"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/65986bb2-a0cd-11f1-85f5-1a8a3ea26666.zip?hash=jFzKqWRAR2CuyYeRRWZ6XPok1LiAdQTcCStbf9tTLCrcXXFjT9CcuuMayCwWE3KzkxDSPuwS29FDCPwW7RHjgBzLX7Icf58SlxXq6Fc9LAh%2Bg8Xk2yw6JVg1au4EIbfQEGPBAzRU3EZ2R6d7aAyoXW7L1co0pX6rFuhyYCsUAlKFCeqzv8aof7YNuyS7hyCV0DwWADhI502L1X115L4jqDd34%2Fd%2BFA0Gqj7ODxY6r3ybE7M%3D"
}
}Download a Zip archive for deal documents ¶
Download a Zip archive for deal documentsGET/deals/:id.zip
Example URI
GET /deals/:id.zip
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Response
200Body
{
"code": "OK",
"data": {
"id": "2abccfb3-8ce0-4c99-b0f7-bbc0f127e24f",
"created_at": 1787693951.60282,
"updated_at": 1787693951.60282,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/c5eb2815-7b04-4be4-a281-1cb603098e68/69060ca0-a0cd-11f1-8f39-f7b7c39ebedd.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/c5eb2815-7b04-4be4-a281-1cb603098e68/69060ca0-a0cd-11f1-8f39-f7b7c39ebedd.zip?Expires=1787780351605&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=CqNlVPJ6MDFqlwQ4MW21h0Wo2TLoL0SDtp0uQkqseQSGtCRqbo6mw0TQ5dHOUK-zaG-nJhjGoDsCDJ-VlrtwLEoS-C0mFBto3j9JHyKynHzZei8U3z4qNpZRFXdwILuq4mTiqWqMUzA9~DdUWzjdpjgA67MlmvXegPODWuBmTXySRoNEYFzcJ8c4I~PQOkF4BroLPZBT9ypeODfjNc3avZ1hd841E8qCLgsKKyYTGUSBtFNd3S-sRoGkcJbDFZpj8QXxYt9Hf3DA785VT~bV7yHMzbBCGtRCP2~XMPZaz37DAE5fO9hmIIeXPat2rdMuWI5A3OO59OpVuVHFklrvhA__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}Download the deal history file ¶
Download the deal history fileGET/deals/:id/history.pdf
Example URI
GET /deals/:id/history.pdf
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Response
200Body
{
"code": "OK",
"data": {
"id": "ef33480b-9647-4b2f-b23c-4179374864e6",
"created_at": 1787693951.645078,
"updated_at": 1787693951.645078,
"deleted_at": null,
"created_by": null,
"path": "deals/c5eb2815-7b04-4be4-a281-1cb603098e68/690d86b0-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "History.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/deals/c5eb2815-7b04-4be4-a281-1cb603098e68/690d86b0-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780351648&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Jzj1AP92r~iySGDn2UvPxp-1-cjbJdNjq1bWaYucSoM3l2pHnFEQJ0f4Ycz33Y-NvY3uuZoWqRh24A7ZjgInL3ADhSubkY-7Nkp2BsJcfNiaSv6eL7D2RsKa~WSuVunjtt86HnUz0-dLThAl6SS3Z37yFIZOTCrFHYqwt0~WhvW~GPNKoP4nbrIkWDZyFQnO3Jjp7Lz0ZAWcoTEnv-FyPZVjYZ8clThrBbXbebj4-KEHO9IJnV2LGOzzl2FMiY01jHOSFWCfTMOp2kAWtny9XVVipI0kic7xp5NhAq80IrGwarA35fG9xKmEbjWEI-v7iLMLmyhne8C9ywqEqOrn4w__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}Download the deal summary file ¶
Download the deal summary fileGET/deals/:id/summary.pdf
Example URI
GET /deals/:id/summary.pdf
URI Parameters
- id
string(required) Example: c5eb2815-7b04-4be4-a281-1cb603098e68
Response
200Body
{
"code": "OK",
"data": {
"id": "9275fc4b-5e3c-4191-b932-48193f7f5040",
"created_at": 1787693951.75664,
"updated_at": 1787693951.75664,
"deleted_at": null,
"created_by": null,
"path": "deals/c5eb2815-7b04-4be4-a281-1cb603098e68/691e9db0-a0cd-11f1-8f39-f7b7c39ebedd.pdf",
"name": "Summary.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/deals/c5eb2815-7b04-4be4-a281-1cb603098e68/691e9db0-a0cd-11f1-8f39-f7b7c39ebedd.pdf?Expires=1787780351759&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=YxLFX-FGloU97d-jfjjbpGQoqMzbG18jjZyeHnVaIy70Ztt4H2tbdKb~ZNPWF-mb8bDhw5QiNDDY12B89KfWtxNt3H2ov8n1t5gOR8wVmxEiXIZFM-MbPTR8h0VsIDMAMsMQvzxcuQhk~9dFqX409p3Be4zWsUOGJtBrQSqxhj7DJmR~rwmZX9boBalunj~5Y5250tOtE8hkxnRPyW3YHdzwsXZRdbWWfAp3wVcO5-Lg4oUkeCM2S-D-kkuQ~XfKY4B8mXPjsCSaVOvrnpQ6SU6kDq39t67xk7PyWBsBPG0tGUWBBxKAElB2jjQw5x0Y-B99ACxRtmLAXey5Pg7UQg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}