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: 42a775db-cc83-4811-b75c-0bc620a222b3
Response
200Body
{
"code": "OK",
"data": {
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-03-22T09:57:11.685Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "d9533ba2-041d-4802-b133-d1557270f38d",
"created_at": 1774173431.806071,
"updated_at": 1774173431.806071,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "27132eed-e3b2-41d3-86f5-c391e733123a",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "ddef5da3-c6eb-4b79-b6c3-9dd5e03f3c2f",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "98f2fdeb-e00a-4806-80bb-61a86b335eb1",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "dd0f4679-9eeb-4ce6-a3f6-f170aaa4178d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "d35b737a-8e07-4439-969b-7bc80f03d91b",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "498753f6-3ccc-40d9-bee0-63faeb2980b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "6dcfcd3b-2476-45da-8aec-4de2d54a56da",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "9c8c72cb-6f8d-49aa-ba2f-044ba303552e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fd8fde05-8b46-4242-ba66-fd919f3a9020",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "23b9c18c-6298-410a-9f2f-61801bdd7425",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "3e909798-19e2-4ab0-a4cf-6e30952294b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "10ff76b1-b9cf-4c42-931b-3b530f2174e8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "2c109394-50eb-4f2a-ae0f-2c3a71739075",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "cfef16ac-2fcb-4d0d-8aeb-eb0e61af0308",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fdd8cffc-0387-4092-88b1-ef15972e5001",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b934b42c-3d69-4fbb-a61f-442f0de1ccdc",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "12fdd6a9-32b5-479b-a274-f5c3de445cd6",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "464d9a26-88ae-48cb-8142-320501c525d2",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "0f874b73-7e39-47f8-b4e7-efb7d661a066",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b3656efb-b91b-447d-a474-6efe5e6ee62d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "de884dc3-4cf6-4646-b5a2-5ab415f14ddb",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-03-22T09:57:11.685Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "d9533ba2-041d-4802-b133-d1557270f38d",
"created_at": 1774173431.806071,
"updated_at": 1774173431.806071,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "27132eed-e3b2-41d3-86f5-c391e733123a",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "ddef5da3-c6eb-4b79-b6c3-9dd5e03f3c2f",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "98f2fdeb-e00a-4806-80bb-61a86b335eb1",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "dd0f4679-9eeb-4ce6-a3f6-f170aaa4178d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "d35b737a-8e07-4439-969b-7bc80f03d91b",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "498753f6-3ccc-40d9-bee0-63faeb2980b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "6dcfcd3b-2476-45da-8aec-4de2d54a56da",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "9c8c72cb-6f8d-49aa-ba2f-044ba303552e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fd8fde05-8b46-4242-ba66-fd919f3a9020",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "23b9c18c-6298-410a-9f2f-61801bdd7425",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "3e909798-19e2-4ab0-a4cf-6e30952294b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "10ff76b1-b9cf-4c42-931b-3b530f2174e8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "2c109394-50eb-4f2a-ae0f-2c3a71739075",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "cfef16ac-2fcb-4d0d-8aeb-eb0e61af0308",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fdd8cffc-0387-4092-88b1-ef15972e5001",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b934b42c-3d69-4fbb-a61f-442f0de1ccdc",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "12fdd6a9-32b5-479b-a274-f5c3de445cd6",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "464d9a26-88ae-48cb-8142-320501c525d2",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "0f874b73-7e39-47f8-b4e7-efb7d661a066",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b3656efb-b91b-447d-a474-6efe5e6ee62d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "de884dc3-4cf6-4646-b5a2-5ab415f14ddb",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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: 443e062d-fd75-4b72-8f17-869fc8e98d3e
Response
200Body
{
"code": "OK",
"data": [
{
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-03-22T09:57:11.685Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "d9533ba2-041d-4802-b133-d1557270f38d",
"created_at": 1774173431.806071,
"updated_at": 1774173431.806071,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "27132eed-e3b2-41d3-86f5-c391e733123a",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "ddef5da3-c6eb-4b79-b6c3-9dd5e03f3c2f",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "98f2fdeb-e00a-4806-80bb-61a86b335eb1",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "dd0f4679-9eeb-4ce6-a3f6-f170aaa4178d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "d35b737a-8e07-4439-969b-7bc80f03d91b",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "498753f6-3ccc-40d9-bee0-63faeb2980b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "6dcfcd3b-2476-45da-8aec-4de2d54a56da",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "9c8c72cb-6f8d-49aa-ba2f-044ba303552e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fd8fde05-8b46-4242-ba66-fd919f3a9020",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "23b9c18c-6298-410a-9f2f-61801bdd7425",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "3e909798-19e2-4ab0-a4cf-6e30952294b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "10ff76b1-b9cf-4c42-931b-3b530f2174e8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "2c109394-50eb-4f2a-ae0f-2c3a71739075",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "cfef16ac-2fcb-4d0d-8aeb-eb0e61af0308",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fdd8cffc-0387-4092-88b1-ef15972e5001",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b934b42c-3d69-4fbb-a61f-442f0de1ccdc",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "12fdd6a9-32b5-479b-a274-f5c3de445cd6",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "464d9a26-88ae-48cb-8142-320501c525d2",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "0f874b73-7e39-47f8-b4e7-efb7d661a066",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b3656efb-b91b-447d-a474-6efe5e6ee62d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "de884dc3-4cf6-4646-b5a2-5ab415f14ddb",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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: 443e062d-fd75-4b72-8f17-869fc8e98d3e
Response
200Body
{
"code": "OK",
"data": [
{
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-03-22T09:57:11.685Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1774173437.469461,
"is_draft": false,
"roles": [
{
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "d9533ba2-041d-4802-b133-d1557270f38d",
"created_at": 1774173431.806071,
"updated_at": 1774173431.806071,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "27132eed-e3b2-41d3-86f5-c391e733123a",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "ddef5da3-c6eb-4b79-b6c3-9dd5e03f3c2f",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "98f2fdeb-e00a-4806-80bb-61a86b335eb1",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "dd0f4679-9eeb-4ce6-a3f6-f170aaa4178d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "d35b737a-8e07-4439-969b-7bc80f03d91b",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "498753f6-3ccc-40d9-bee0-63faeb2980b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "6dcfcd3b-2476-45da-8aec-4de2d54a56da",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "9c8c72cb-6f8d-49aa-ba2f-044ba303552e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fd8fde05-8b46-4242-ba66-fd919f3a9020",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "23b9c18c-6298-410a-9f2f-61801bdd7425",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "3e909798-19e2-4ab0-a4cf-6e30952294b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "10ff76b1-b9cf-4c42-931b-3b530f2174e8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "2c109394-50eb-4f2a-ae0f-2c3a71739075",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "cfef16ac-2fcb-4d0d-8aeb-eb0e61af0308",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fdd8cffc-0387-4092-88b1-ef15972e5001",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b934b42c-3d69-4fbb-a61f-442f0de1ccdc",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "12fdd6a9-32b5-479b-a274-f5c3de445cd6",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "464d9a26-88ae-48cb-8142-320501c525d2",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "0f874b73-7e39-47f8-b4e7-efb7d661a066",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b3656efb-b91b-447d-a474-6efe5e6ee62d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "de884dc3-4cf6-4646-b5a2-5ab415f14ddb",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": [
"Contract"
],
"attention_requests": 1,
"has_active_offer": true,
"array_agg": null,
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-03-22T09:57:11.685Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "d9533ba2-041d-4802-b133-d1557270f38d",
"created_at": 1774173431.806071,
"updated_at": 1774173431.806071,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "27132eed-e3b2-41d3-86f5-c391e733123a",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "ddef5da3-c6eb-4b79-b6c3-9dd5e03f3c2f",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "98f2fdeb-e00a-4806-80bb-61a86b335eb1",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "dd0f4679-9eeb-4ce6-a3f6-f170aaa4178d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "d35b737a-8e07-4439-969b-7bc80f03d91b",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "498753f6-3ccc-40d9-bee0-63faeb2980b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "6dcfcd3b-2476-45da-8aec-4de2d54a56da",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "9c8c72cb-6f8d-49aa-ba2f-044ba303552e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fd8fde05-8b46-4242-ba66-fd919f3a9020",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "23b9c18c-6298-410a-9f2f-61801bdd7425",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "3e909798-19e2-4ab0-a4cf-6e30952294b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "10ff76b1-b9cf-4c42-931b-3b530f2174e8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "2c109394-50eb-4f2a-ae0f-2c3a71739075",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "cfef16ac-2fcb-4d0d-8aeb-eb0e61af0308",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fdd8cffc-0387-4092-88b1-ef15972e5001",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b934b42c-3d69-4fbb-a61f-442f0de1ccdc",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "12fdd6a9-32b5-479b-a274-f5c3de445cd6",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "464d9a26-88ae-48cb-8142-320501c525d2",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "0f874b73-7e39-47f8-b4e7-efb7d661a066",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b3656efb-b91b-447d-a474-6efe5e6ee62d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "de884dc3-4cf6-4646-b5a2-5ab415f14ddb",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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": "ec0cb66d-5842-4cda-9135-5d37942757bb"
}Response
200Body
{
"code": "OK",
"data": {
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "[Draft]",
"gallery": {
"id": "7eca9b1e-25d5-11f1-93fb-7201c7f492dc",
"created_at": 1774173431.0665,
"updated_at": 1774173431.066501,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"created_at": 1774173430.733856,
"updated_at": 1774173430.733856,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "77ac7295-97a1-407b-8c6f-bb92575f355b",
"created_at": 1774173429.529476,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "d0f07137-7c8d-487e-b625-600602296f02",
"created_at": 1774173429.529476,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "23a858f3-1066-4499-8809-90d9350aa533",
"created_at": 1774173429.529476,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"checklist_type": "Offer",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": false,
"array_agg": null,
"email": "[email protected]"
}
}Delete a deal ¶
Delete a dealDELETE/deals/:id
Example URI
DELETE /deals/:id
URI Parameters
- id
string(required) Example: 42a775db-cc83-4811-b75c-0bc620a222b3
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: 42a775db-cc83-4811-b75c-0bc620a222b3
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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "d9533ba2-041d-4802-b133-d1557270f38d",
"created_at": 1774173431.806071,
"updated_at": 1774173431.806071,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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: 42a775db-cc83-4811-b75c-0bc620a222b3- rid
string(required) Example: 004c79db-feb2-4101-9e89-71fec816e1db
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "004c79db-feb2-4101-9e89-71fec816e1db"
}Response
200Body
{
"code": "OK",
"data": {
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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: 42a775db-cc83-4811-b75c-0bc620a222b3
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "27132eed-e3b2-41d3-86f5-c391e733123a",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "ddef5da3-c6eb-4b79-b6c3-9dd5e03f3c2f",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "98f2fdeb-e00a-4806-80bb-61a86b335eb1",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "dd0f4679-9eeb-4ce6-a3f6-f170aaa4178d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "d35b737a-8e07-4439-969b-7bc80f03d91b",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "498753f6-3ccc-40d9-bee0-63faeb2980b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "6dcfcd3b-2476-45da-8aec-4de2d54a56da",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "9c8c72cb-6f8d-49aa-ba2f-044ba303552e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fd8fde05-8b46-4242-ba66-fd919f3a9020",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "23b9c18c-6298-410a-9f2f-61801bdd7425",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "3e909798-19e2-4ab0-a4cf-6e30952294b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "10ff76b1-b9cf-4c42-931b-3b530f2174e8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "2c109394-50eb-4f2a-ae0f-2c3a71739075",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "cfef16ac-2fcb-4d0d-8aeb-eb0e61af0308",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fdd8cffc-0387-4092-88b1-ef15972e5001",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b934b42c-3d69-4fbb-a61f-442f0de1ccdc",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "12fdd6a9-32b5-479b-a274-f5c3de445cd6",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "464d9a26-88ae-48cb-8142-320501c525d2",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "0f874b73-7e39-47f8-b4e7-efb7d661a066",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b3656efb-b91b-447d-a474-6efe5e6ee62d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "de884dc3-4cf6-4646-b5a2-5ab415f14ddb",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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: 42a775db-cc83-4811-b75c-0bc620a222b3- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb"
}Response
200Body
{
"code": "OK",
"data": {
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "5020 Junius Street",
"property_type": {
"id": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"created_at": 1774173430.733856,
"updated_at": 1774173430.733856,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "77ac7295-97a1-407b-8c6f-bb92575f355b",
"created_at": 1774173429.529476,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "d0f07137-7c8d-487e-b625-600602296f02",
"created_at": 1774173429.529476,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "23a858f3-1066-4499-8809-90d9350aa533",
"created_at": 1774173429.529476,
"deleted_at": null,
"brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb",
"checklist_type": "Offer",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "27132eed-e3b2-41d3-86f5-c391e733123a",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "ddef5da3-c6eb-4b79-b6c3-9dd5e03f3c2f",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "98f2fdeb-e00a-4806-80bb-61a86b335eb1",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "dd0f4679-9eeb-4ce6-a3f6-f170aaa4178d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "d35b737a-8e07-4439-969b-7bc80f03d91b",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "498753f6-3ccc-40d9-bee0-63faeb2980b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "6dcfcd3b-2476-45da-8aec-4de2d54a56da",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "9c8c72cb-6f8d-49aa-ba2f-044ba303552e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fd8fde05-8b46-4242-ba66-fd919f3a9020",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "23b9c18c-6298-410a-9f2f-61801bdd7425",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "3e909798-19e2-4ab0-a4cf-6e30952294b5",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "10ff76b1-b9cf-4c42-931b-3b530f2174e8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "2c109394-50eb-4f2a-ae0f-2c3a71739075",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "cfef16ac-2fcb-4d0d-8aeb-eb0e61af0308",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "fdd8cffc-0387-4092-88b1-ef15972e5001",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b934b42c-3d69-4fbb-a61f-442f0de1ccdc",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "12fdd6a9-32b5-479b-a274-f5c3de445cd6",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "464d9a26-88ae-48cb-8142-320501c525d2",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "0f874b73-7e39-47f8-b4e7-efb7d661a066",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "b3656efb-b91b-447d-a474-6efe5e6ee62d",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "MLS",
"definition": "de884dc3-4cf6-4646-b5a2-5ab415f14ddb",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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: 42a775db-cc83-4811-b75c-0bc620a222b3
Request
Body
{
"context": [
{
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"value": "2017/12/06"
},
{
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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: 42a775db-cc83-4811-b75c-0bc620a222b3- cid
string(required) Example: 78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_at": 1774173431.066381,
"updated_at": 1774173431.066381,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "abb4bd73-e58c-406c-b4b3-7af71225df29",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "e7f0d52d-2f55-47d9-9dd7-87c62d767785",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": null,
"source": "PropertyType",
"definition": "61b39f20-791c-4062-8b2a-ea8045931df6",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": "2026-03-22T09:57:09.529476+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-03-22T09:57:11.384296+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"source": "Provided",
"definition": "463bc2e9-2093-4791-86dc-e5e471e628c8",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"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: 42a775db-cc83-4811-b75c-0bc620a222b3- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "78ff6a5d-a5bc-4c11-a0e6-13ac17fd501c",
"type": "deal_context_item",
"created_at": 1774173429.529476,
"approved_at": 1774173431.384296,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e"
}
],
"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: 42a775db-cc83-4811-b75c-0bc620a222b3
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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "004c79db-feb2-4101-9e89-71fec816e1db",
"created_at": 1774173431.802618,
"updated_at": 1774173431.802618,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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": "d9533ba2-041d-4802-b133-d1557270f38d",
"created_at": 1774173431.806071,
"updated_at": 1774173431.806071,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"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: 42a775db-cc83-4811-b75c-0bc620a222b3- rid
string(required) Example: 004c79db-feb2-4101-9e89-71fec816e1db
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: 42a775db-cc83-4811-b75c-0bc620a222b3
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "ec0cb66d-5842-4cda-9135-5d37942757bb"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "5259dde0-287c-435c-ba8a-76c9791db99e",
"created_at": 1774173429.529476,
"updated_at": 1774173429.529476,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"order": 1,
"origin": "23a858f3-1066-4499-8809-90d9350aa533",
"terminated_at": null,
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": false,
"is_terminated": false,
"tasks": null,
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"tab_name": "Contract",
"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: 42a775db-cc83-4811-b75c-0bc620a222b3- cid
string(required) Example: 5259dde0-287c-435c-ba8a-76c9791db99e
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "5259dde0-287c-435c-ba8a-76c9791db99e"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5259dde0-287c-435c-ba8a-76c9791db99e",
"created_at": 1774173429.529476,
"updated_at": 1774173429.529476,
"deleted_at": null,
"deactivated_at": "2026-03-22T09:57:17.918Z",
"title": "Updated Checklist 1",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"order": 3,
"origin": "23a858f3-1066-4499-8809-90d9350aa533",
"terminated_at": "2026-03-22T09:57:17.918Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "684250eb-0b9f-4f13-b5bb-c7eba1627dc8",
"created_at": 1774173432.700623,
"updated_at": 1774173437.778755,
"room": {
"type": "room",
"id": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f",
"title": "5020 Junius Street: Test Title",
"created_at": 1774173432.68159,
"updated_at": 1774173437.410573,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "90c03099-44d0-46c9-a2d0-b5754d6427f0",
"last_revision": "c3b55a1f-c370-481d-b682-36020b032290",
"state": "Fair",
"created_at": 1774173435.808233,
"updated_at": 1774173436.376482,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b5cfc552-11f9-472d-9ad2-1d949d3ed3ef",
"created_at": 1774173436.399545,
"updated_at": 1774173436.399545,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf?Expires=1774259836405&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=cV8X0vG-Uy081R1LQ3DMez2akBXqCMgMkMPKWOIQqQU8Ijk9zymIwQWXXnYknqcs39A66j5ZlTYW1lRBh4AHgeZ8d6YiqiyKRwbCdkOuvHns4qwGJvcrA3o-4JfUSubq~iC4U7F6DXKJJOVoLOphqC4dLXhUDjZ3QaSoEjFjnnZTdMn6XOfYbrfvN1-9L0RyXDeI2jI6iVZh8jcVTOLVjCSzEX1JkQQ20oudoHA8-VHzCvsFMTzjaKV0ZPp6Jit0tDjaLRjFViHrf3vVzamIDH~fTzFi1hbl8v7Z6SGmqfYsf7a3HHCytoUhLoHcLf3MXoWMo24cU8rwRH8GwBaR1g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "cc8f7981-279a-4c89-933a-8080ced11f6a",
"created_at": 1774173436.847582,
"type": "review",
"status": "Declined",
"updated_at": 1774173436.84959
},
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/submission.pdf?hash=jFzZqXtHACj13YWHQWZzAa5rhuiUchmLCzdZY99XY3DEWHMrHNCV7eJIzX0YB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXylAuB6eUIATg%3D%3D"
}
],
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"tab_name": "Contract",
"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: 684250eb-0b9f-4f13-b5bb-c7eba1627dc8
Response
200Body
{
"code": "OK",
"data": {
"id": "684250eb-0b9f-4f13-b5bb-c7eba1627dc8",
"created_at": 1774173432.700623,
"updated_at": 1774173435.851897,
"room": {
"type": "room",
"id": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f",
"title": "5020 Junius Street: Test Title",
"created_at": 1774173432.68159,
"updated_at": 1774173436.609242,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "90c03099-44d0-46c9-a2d0-b5754d6427f0",
"last_revision": "c3b55a1f-c370-481d-b682-36020b032290",
"state": "Fair",
"created_at": 1774173435.808233,
"updated_at": 1774173436.376482,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b5cfc552-11f9-472d-9ad2-1d949d3ed3ef",
"created_at": 1774173436.399545,
"updated_at": 1774173436.399545,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf?Expires=1774259836405&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=cV8X0vG-Uy081R1LQ3DMez2akBXqCMgMkMPKWOIQqQU8Ijk9zymIwQWXXnYknqcs39A66j5ZlTYW1lRBh4AHgeZ8d6YiqiyKRwbCdkOuvHns4qwGJvcrA3o-4JfUSubq~iC4U7F6DXKJJOVoLOphqC4dLXhUDjZ3QaSoEjFjnnZTdMn6XOfYbrfvN1-9L0RyXDeI2jI6iVZh8jcVTOLVjCSzEX1JkQQ20oudoHA8-VHzCvsFMTzjaKV0ZPp6Jit0tDjaLRjFViHrf3vVzamIDH~fTzFi1hbl8v7Z6SGmqfYsf7a3HHCytoUhLoHcLf3MXoWMo24cU8rwRH8GwBaR1g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/submission.pdf?hash=jFzZqXtHACj13YWHQWZzAa5rhuiUchmLCzdZY99XY3DEWHMrHNCV7eJIzX0YB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXykAu50f0IATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: 42a775db-cc83-4811-b75c-0bc620a222b3
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"is_deletable": true,
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f"
}Response
200Body
{
"code": "OK",
"data": {
"id": "684250eb-0b9f-4f13-b5bb-c7eba1627dc8",
"created_at": 1774173432.700623,
"updated_at": 1774173432.700624,
"room": {
"type": "room",
"id": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f",
"title": "5020 Junius Street: Test Title",
"created_at": 1774173432.68159,
"updated_at": 1774173432.798814,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/submission.pdf?hash=jFzZqXtHACj13YWHQWZzAa5rhuiUchmLCzdZY99XY3DEWHMrHNCV7eJIzX0YB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXygAuB3fEIATg%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: 684250eb-0b9f-4f13-b5bb-c7eba1627dc8
Request
Body
{
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"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": "90c03099-44d0-46c9-a2d0-b5754d6427f0",
"last_revision": "60b414d7-da7d-414f-a189-33f2a79d8749",
"state": "Fair",
"created_at": 1774173435.808233,
"updated_at": 1774173436.063345,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "58eb3b8f-b2b5-4d3d-bf23-123d0a55852a",
"created_at": 1774173436.092567,
"updated_at": 1774173436.092567,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81c5c640-25d5-11f1-83ca-c9fd0d26db3c.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81c5c640-25d5-11f1-83ca-c9fd0d26db3c.pdf?Expires=1774259836097&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Rjw0R~w9GCTVkK0NHysUhaNpJy~W0Y84abrD0XnIfXOLBbK8ARcCe-Ep1prZSnXCIfKOa-ubIy2A5IR651Kx4k-2a0jw4zR-PjiVbHr-TrdWb0HDo7QBC1AFm-FHdceDDsbUYndKND384ZEs6b4ZtIfl-aeDh88WpHTZxdzt0PwMw9SL3AEzf9FnczF5vxBP64JydcwWe4xfyocjLR1HC413zFNGQBzYiD6bZgVKMrDwck4nfZNNm2wD1CV~i7sknuwGhSIq9Bh-e2kt8irBpwzHWHONUxOQV8jKVAdFOYIaxf83yS5wgn38kqKQVgzi519J0YEJQgNYE2QNiPLiFA__",
"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: 684250eb-0b9f-4f13-b5bb-c7eba1627dc8- revision
string(required) Example: 60b414d7-da7d-414f-a189-33f2a79d8749
Response
200Body
{
"code": "OK",
"data": {
"id": "60b414d7-da7d-414f-a189-33f2a79d8749",
"submission": "90c03099-44d0-46c9-a2d0-b5754d6427f0",
"created_at": 1774173435.808233,
"updated_at": 1774173436.063345,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "58eb3b8f-b2b5-4d3d-bf23-123d0a55852a"
}
}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: 684250eb-0b9f-4f13-b5bb-c7eba1627dc8
Request
Body
{
"status": "Declined",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "684250eb-0b9f-4f13-b5bb-c7eba1627dc8",
"created_at": 1774173432.700623,
"updated_at": 1774173436.857129,
"room": {
"type": "room",
"id": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f",
"title": "5020 Junius Street: Test Title",
"created_at": 1774173432.68159,
"updated_at": 1774173436.895128,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "90c03099-44d0-46c9-a2d0-b5754d6427f0",
"last_revision": "c3b55a1f-c370-481d-b682-36020b032290",
"state": "Fair",
"created_at": 1774173435.808233,
"updated_at": 1774173436.376482,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b5cfc552-11f9-472d-9ad2-1d949d3ed3ef",
"created_at": 1774173436.399545,
"updated_at": 1774173436.399545,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf?Expires=1774259836405&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=cV8X0vG-Uy081R1LQ3DMez2akBXqCMgMkMPKWOIQqQU8Ijk9zymIwQWXXnYknqcs39A66j5ZlTYW1lRBh4AHgeZ8d6YiqiyKRwbCdkOuvHns4qwGJvcrA3o-4JfUSubq~iC4U7F6DXKJJOVoLOphqC4dLXhUDjZ3QaSoEjFjnnZTdMn6XOfYbrfvN1-9L0RyXDeI2jI6iVZh8jcVTOLVjCSzEX1JkQQ20oudoHA8-VHzCvsFMTzjaKV0ZPp6Jit0tDjaLRjFViHrf3vVzamIDH~fTzFi1hbl8v7Z6SGmqfYsf7a3HHCytoUhLoHcLf3MXoWMo24cU8rwRH8GwBaR1g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "cc8f7981-279a-4c89-933a-8080ced11f6a",
"created_at": 1774173436.847582,
"type": "review",
"status": "Declined",
"updated_at": 1774173436.84959
},
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/submission.pdf?hash=jFzZqXtHACj13YWHQWZzAa5rhuiUchmLCzdZY99XY3DEWHMrHNCV7eJIzX0YB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXylAulxfkIATg%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: 684250eb-0b9f-4f13-b5bb-c7eba1627dc8
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "684250eb-0b9f-4f13-b5bb-c7eba1627dc8",
"created_at": 1774173432.700623,
"updated_at": 1774173437.469461,
"room": {
"type": "room",
"id": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f",
"title": "5020 Junius Street: Test Title",
"created_at": 1774173432.68159,
"updated_at": 1774173437.410573,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "90c03099-44d0-46c9-a2d0-b5754d6427f0",
"last_revision": "c3b55a1f-c370-481d-b682-36020b032290",
"state": "Fair",
"created_at": 1774173435.808233,
"updated_at": 1774173436.376482,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b5cfc552-11f9-472d-9ad2-1d949d3ed3ef",
"created_at": 1774173436.399545,
"updated_at": 1774173436.399545,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81f588d0-25d5-11f1-83ca-c9fd0d26db3c.pdf?Expires=1774259836405&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=cV8X0vG-Uy081R1LQ3DMez2akBXqCMgMkMPKWOIQqQU8Ijk9zymIwQWXXnYknqcs39A66j5ZlTYW1lRBh4AHgeZ8d6YiqiyKRwbCdkOuvHns4qwGJvcrA3o-4JfUSubq~iC4U7F6DXKJJOVoLOphqC4dLXhUDjZ3QaSoEjFjnnZTdMn6XOfYbrfvN1-9L0RyXDeI2jI6iVZh8jcVTOLVjCSzEX1JkQQ20oudoHA8-VHzCvsFMTzjaKV0ZPp6Jit0tDjaLRjFViHrf3vVzamIDH~fTzFi1hbl8v7Z6SGmqfYsf7a3HHCytoUhLoHcLf3MXoWMo24cU8rwRH8GwBaR1g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "cc8f7981-279a-4c89-933a-8080ced11f6a",
"created_at": 1774173436.847582,
"type": "review",
"status": "Declined",
"updated_at": 1774173436.84959
},
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-03-22T09:57:17.469Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/submission.pdf?hash=jFzZqXtHACj13YWHQWZzAa5rhuiUchmLCzdZY99XY3DEWHMrHNCV7eJIzX0YB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXylAux3dkIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: 02ae8f0e-95a5-411f-ac35-43cc6f699d83
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "02ae8f0e-95a5-411f-ac35-43cc6f699d83",
"created_at": 1774173433.029834,
"updated_at": 1774173433.939734,
"room": {
"type": "room",
"id": "25f80cf6-cb06-4732-9a46-2db2c276d1eb",
"title": "5020 Junius Street: Another Task",
"created_at": 1774173433.013178,
"updated_at": 1774173433.146289,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/02ae8f0e-95a5-411f-ac35-43cc6f699d83/submission.pdf?hash=jFzZqXtHACj124%2FSFmslVKlrj7%2FMIRmLXDcMY9wBMifED3ctHYfC7elGzSYTB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXymAul2fEIATg%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: 42a775db-cc83-4811-b75c-0bc620a222b3
Request
Body
[
{
"id": "684250eb-0b9f-4f13-b5bb-c7eba1627dc8",
"title": "Bulk Test Title"
},
{
"id": "02ae8f0e-95a5-411f-ac35-43cc6f699d83",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "684250eb-0b9f-4f13-b5bb-c7eba1627dc8",
"created_at": 1774173432.700623,
"updated_at": 1774173434.151378,
"room": {
"type": "room",
"id": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f",
"title": "5020 Junius Street: Test Title",
"created_at": 1774173432.68159,
"updated_at": 1774173433.698372,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"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": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/submission.pdf?hash=jFzZqXtHACj13YWHQWZzAa5rhuiUchmLCzdZY99XY3DEWHMrHNCV7eJIzX0YB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXymAu1xd0IATg%3D%3D"
},
{
"id": "02ae8f0e-95a5-411f-ac35-43cc6f699d83",
"created_at": 1774173433.029834,
"updated_at": 1774173434.316766,
"room": {
"type": "room",
"id": "25f80cf6-cb06-4732-9a46-2db2c276d1eb",
"title": "5020 Junius Street: Another Task",
"created_at": 1774173433.013178,
"updated_at": 1774173434.252066,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "353b76c4-4afc-4e57-8722-19612d0c8c67",
"checklist": "5259dde0-287c-435c-ba8a-76c9791db99e",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-03-22T09:57:14.316Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "42a775db-cc83-4811-b75c-0bc620a222b3",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/02ae8f0e-95a5-411f-ac35-43cc6f699d83/submission.pdf?hash=jFzZqXtHACj124%2FSFmslVKlrj7%2FMIRmLXDcMY9wBMifED3ctHYfC7elGzSYTB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2BaA6iJGzHu80ypXymAu1xd0IATg%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: 684250eb-0b9f-4f13-b5bb-c7eba1627dc8
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "58eb3b8f-b2b5-4d3d-bf23-123d0a55852a"
}Response
200Body
{
"code": "OK",
"data": {
"id": "d674cfe0-60d0-47c9-a031-7116774e165f",
"reference": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"reference_type": "User",
"created_at": 1774173436.589486,
"updated_at": 1774173436.589486,
"deleted_at": null,
"object": {
"id": "58eb3b8f-b2b5-4d3d-bf23-123d0a55852a",
"created_at": 1774173436.092567,
"updated_at": 1774173436.092567,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81c5c640-25d5-11f1-83ca-c9fd0d26db3c.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/684250eb-0b9f-4f13-b5bb-c7eba1627dc8/81c5c640-25d5-11f1-83ca-c9fd0d26db3c.pdf?Expires=1774259836097&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Rjw0R~w9GCTVkK0NHysUhaNpJy~W0Y84abrD0XnIfXOLBbK8ARcCe-Ep1prZSnXCIfKOa-ubIy2A5IR651Kx4k-2a0jw4zR-PjiVbHr-TrdWb0HDo7QBC1AFm-FHdceDDsbUYndKND384ZEs6b4ZtIfl-aeDh88WpHTZxdzt0PwMw9SL3AEzf9FnczF5vxBP64JydcwWe4xfyocjLR1HC413zFNGQBzYiD6bZgVKMrDwck4nfZNNm2wD1CV~i7sknuwGhSIq9Bh-e2kt8irBpwzHWHONUxOQV8jKVAdFOYIaxf83yS5wgn38kqKQVgzi519J0YEJQgNYE2QNiPLiFA__",
"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: 684250eb-0b9f-4f13-b5bb-c7eba1627dc8
Request
Body
{
"comment": "Comment",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "64b165ee-91d2-4441-8d75-0e49f0a2f763",
"id": "64b165ee-91d2-4441-8d75-0e49f0a2f763",
"comment": "Comment",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": {
"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": 1774173429.529476,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"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": 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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "4:57 AM - Sunday Mar 22, 2026",
"push_allowed": false,
"agents": [
{
"id": "0e558f63-beeb-49eb-b2b2-ba1c6e34acef",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1774173429.66639,
"deleted_at": null,
"created_at": 1774173429.66639,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "443e062d-fd75-4b72-8f17-869fc8e98d3e",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"created_at": 1774173438.07997,
"updated_at": 1774173438.07997,
"room": "d1e741ca-2da0-4ebd-8dbe-42b083cef20f",
"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,
"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: 02ae8f0e-95a5-411f-ac35-43cc6f699d83
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: 42a775db-cc83-4811-b75c-0bc620a222b3
Response
200Body
{
"code": "OK",
"data": {
"id": "5b842ce7-b23f-45d7-b34c-116f70efe398",
"created_at": 1774173438.715977,
"updated_at": 1774173438.715977,
"deleted_at": null,
"gallery": "7eca9b1e-25d5-11f1-93fb-7201c7f492dc",
"name": null,
"order": 0,
"file": {
"id": "77ead3e8-f5a1-4aa8-b42f-53fb185a97d8",
"created_at": 1774173438.709993,
"updated_at": 1774173438.709993,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "42a775db-cc83-4811-b75c-0bc620a222b3/8357ff00-25d5-11f1-83ca-c9fd0d26db3c.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/42a775db-cc83-4811-b75c-0bc620a222b3/8357ff00-25d5-11f1-83ca-c9fd0d26db3c.png",
"preview_url": "https://test.cloudfront.net/42a775db-cc83-4811-b75c-0bc620a222b3/8357ff00-25d5-11f1-83ca-c9fd0d26db3c.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: 42a775db-cc83-4811-b75c-0bc620a222b3- iid
string(required) Example: 5b842ce7-b23f-45d7-b34c-116f70efe398
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "77ead3e8-f5a1-4aa8-b42f-53fb185a97d8"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5b842ce7-b23f-45d7-b34c-116f70efe398",
"created_at": 1774173438.715977,
"updated_at": 1774173429.529476,
"deleted_at": null,
"gallery": "7eca9b1e-25d5-11f1-93fb-7201c7f492dc",
"name": "Updated Name",
"order": 2,
"file": {
"id": "77ead3e8-f5a1-4aa8-b42f-53fb185a97d8",
"created_at": 1774173438.709993,
"updated_at": 1774173438.709993,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "42a775db-cc83-4811-b75c-0bc620a222b3/8357ff00-25d5-11f1-83ca-c9fd0d26db3c.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/42a775db-cc83-4811-b75c-0bc620a222b3/8357ff00-25d5-11f1-83ca-c9fd0d26db3c.png",
"preview_url": "https://test.cloudfront.net/42a775db-cc83-4811-b75c-0bc620a222b3/8357ff00-25d5-11f1-83ca-c9fd0d26db3c.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: 42a775db-cc83-4811-b75c-0bc620a222b3- iid
string(required) Example: 5b842ce7-b23f-45d7-b34c-116f70efe398
Response
200Body
{
"code": "OK",
"data": {
"id": "5b842ce7-b23f-45d7-b34c-116f70efe398",
"created_at": 1774173438.715977,
"updated_at": 1774173429.529476,
"deleted_at": null,
"gallery": "7eca9b1e-25d5-11f1-93fb-7201c7f492dc",
"name": "Updated Name",
"order": 2,
"file": {
"id": "d775dbb5-7ff4-4e9e-b544-f86fc519a8fd",
"created_at": 1774173438.807009,
"updated_at": 1774173438.807009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "42a775db-cc83-4811-b75c-0bc620a222b3/83671a30-25d5-11f1-83ca-c9fd0d26db3c.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/42a775db-cc83-4811-b75c-0bc620a222b3/83671a30-25d5-11f1-83ca-c9fd0d26db3c.png?Expires=1774259838811&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NkcgWyHwmxZWAn6iYU0Pv6t1Hz2F2VBLVSOUUgpavcKfVJiBoGGqxmXwkfvBj-FrOoPDzK2snB39nVaPZGANYYSEtsEqDR~efDl8IR~Gp341w7rAtyBXH4SoScBYsAcuifldKXjpK90iXbpb2MJgsy2YHmcLKbCNL8VoztY~AANbp41aWVvPJQ~PT2rTBvZ2Um2Kqg0iImnh49YcyIxE0y1dfL2UGxasavjoVlkX~DBv8vKUZnyO9cQSuMpKakviqfRkwKqzDljhdpOJynYA9krFssr8z47ddKdq3SS-TDYq73m8HOR61ZpQIb7jklue9kxUL3K~PC6C2SptQBNrlg__",
"preview_url": "https://private-cdn.irish.rechat.com/42a775db-cc83-4811-b75c-0bc620a222b3/83671a30-25d5-11f1-83ca-c9fd0d26db3c.png?Expires=1774259838811&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NkcgWyHwmxZWAn6iYU0Pv6t1Hz2F2VBLVSOUUgpavcKfVJiBoGGqxmXwkfvBj-FrOoPDzK2snB39nVaPZGANYYSEtsEqDR~efDl8IR~Gp341w7rAtyBXH4SoScBYsAcuifldKXjpK90iXbpb2MJgsy2YHmcLKbCNL8VoztY~AANbp41aWVvPJQ~PT2rTBvZ2Um2Kqg0iImnh49YcyIxE0y1dfL2UGxasavjoVlkX~DBv8vKUZnyO9cQSuMpKakviqfRkwKqzDljhdpOJynYA9krFssr8z47ddKdq3SS-TDYq73m8HOR61ZpQIb7jklue9kxUL3K~PC6C2SptQBNrlg__",
"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: 42a775db-cc83-4811-b75c-0bc620a222b3
Request
Body
[
{
"id": "5b842ce7-b23f-45d7-b34c-116f70efe398",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "5b842ce7-b23f-45d7-b34c-116f70efe398",
"created_at": 1774173438.715977,
"updated_at": 1774173429.529476,
"deleted_at": 1774173429.529476,
"gallery": "7eca9b1e-25d5-11f1-93fb-7201c7f492dc",
"name": "Updated Name",
"order": 3,
"file": {
"id": "d775dbb5-7ff4-4e9e-b544-f86fc519a8fd",
"created_at": 1774173438.807009,
"updated_at": 1774173438.807009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "42a775db-cc83-4811-b75c-0bc620a222b3/83671a30-25d5-11f1-83ca-c9fd0d26db3c.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/42a775db-cc83-4811-b75c-0bc620a222b3/83671a30-25d5-11f1-83ca-c9fd0d26db3c.png?Expires=1774259838811&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NkcgWyHwmxZWAn6iYU0Pv6t1Hz2F2VBLVSOUUgpavcKfVJiBoGGqxmXwkfvBj-FrOoPDzK2snB39nVaPZGANYYSEtsEqDR~efDl8IR~Gp341w7rAtyBXH4SoScBYsAcuifldKXjpK90iXbpb2MJgsy2YHmcLKbCNL8VoztY~AANbp41aWVvPJQ~PT2rTBvZ2Um2Kqg0iImnh49YcyIxE0y1dfL2UGxasavjoVlkX~DBv8vKUZnyO9cQSuMpKakviqfRkwKqzDljhdpOJynYA9krFssr8z47ddKdq3SS-TDYq73m8HOR61ZpQIb7jklue9kxUL3K~PC6C2SptQBNrlg__",
"preview_url": "https://private-cdn.irish.rechat.com/42a775db-cc83-4811-b75c-0bc620a222b3/83671a30-25d5-11f1-83ca-c9fd0d26db3c.png?Expires=1774259838811&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NkcgWyHwmxZWAn6iYU0Pv6t1Hz2F2VBLVSOUUgpavcKfVJiBoGGqxmXwkfvBj-FrOoPDzK2snB39nVaPZGANYYSEtsEqDR~efDl8IR~Gp341w7rAtyBXH4SoScBYsAcuifldKXjpK90iXbpb2MJgsy2YHmcLKbCNL8VoztY~AANbp41aWVvPJQ~PT2rTBvZ2Um2Kqg0iImnh49YcyIxE0y1dfL2UGxasavjoVlkX~DBv8vKUZnyO9cQSuMpKakviqfRkwKqzDljhdpOJynYA9krFssr8z47ddKdq3SS-TDYq73m8HOR61ZpQIb7jklue9kxUL3K~PC6C2SptQBNrlg__",
"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: 42a775db-cc83-4811-b75c-0bc620a222b3
Request
Body
{
"items": [
"5b842ce7-b23f-45d7-b34c-116f70efe398"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/7eca9b1e-25d5-11f1-93fb-7201c7f492dc.zip?hash=jFzKqWRAR2CuyYeRRDYgBfUkh%2B%2BAJgHbWCtbf9tTLCvaXSZjSYOU6rNIzyoZFyDmkxDSPuwS29FDCKVDtEbmgEfBX7kWJ5cSkh3puldnfF9wg5WxjiM9LFcybr1WdrfQEGPBAzRU3EZ2R6d7aAyjXW7M1cg8pXilFuh7YCEVA1KFCeqzv8aof7YNuyS713zC1GZKDzge5BiM1X10t7ojqzUn5vd2E19V%2FDaaCkNvpSGbE7M%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: 42a775db-cc83-4811-b75c-0bc620a222b3
Response
200Body
{
"code": "OK",
"data": {
"id": "dafeffe2-4c21-43e5-a2bf-9920470e56db",
"created_at": 1774173439.274243,
"updated_at": 1774173439.274243,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/42a775db-cc83-4811-b75c-0bc620a222b3/83acfcd0-25d5-11f1-83ca-c9fd0d26db3c.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/42a775db-cc83-4811-b75c-0bc620a222b3/83acfcd0-25d5-11f1-83ca-c9fd0d26db3c.zip?Expires=1774259839279&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ZZmjiNeC1Ydg3MLVy~37iCzPjKc6D15fC2o0vqU-KX~z5oqpMbFJc27t80tXwHZ~0bOJd0CyQwrgJ9CfpfRD9W60PiySRGH~69IBv0r4Hv5tA20e0HMb9rTlhInu1VpOAcKDQvbxfsGKkirhBJtbjAKSltwmVBGc7Lms40QHYMqSEwguXopoceI0FpzvtiWSE3Sh-o-IqQfElMkZN3ZlKO5CinTxLvtMUzcVcWmVoVQ~I6UkMAcwt~ldSQF02XGsy31vdKjL3TMLt8K9lpJ1B5e5WiyFuFFDsDs5qnyyMLc3d3k-T2uXbiifTLyMWxE-jxefzgP-HVZJSJiyBOgT~Q__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}