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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Response
200Body
{
"code": "OK",
"data": {
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "2025-10-14T19:26:51.261Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "a9d6c0bc-5b36-4f33-b667-1b6a72e40179",
"created_at": 1760470011.363311,
"updated_at": 1760470011.363311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c864ea4d-976b-48e8-b348-823bff22c5c9",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "653a0851-42cc-4c5a-aaae-62a4c70fde16",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "31721330-71ad-492f-b6b8-11bdb7bfb8ed",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "e516e7cb-c248-4842-836f-63f554c6f6e4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "0a9f89ce-02cc-473f-a0a7-58b064f613ba",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6abfb94b-8acf-4943-9b3e-c670f50d50e3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a874cb57-ecc7-4abd-a220-52cd1ed49e5e",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "28831a79-5621-4f6b-91f5-eadf17f6c063",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6a346bf6-c8bd-47be-9513-47104c7f61a4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "4b89a0cd-cde5-4053-97e5-ee4808d826dc",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c3f3aea6-563a-4e04-bdae-d40f9b83b1e0",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a45bb140-b49d-4121-a562-649b78a76208",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "d0f18e58-b11c-4c43-97cb-5c1f608c4965",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "3e20b751-a705-4eb8-ae61-116e89640e64",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "7f85b80e-9599-45ec-9702-332171aa2dc2",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "113a62c2-43c9-4ce4-970f-4ba380b6b5b6",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "fda5e090-7624-4d6a-9315-58dce7bed149",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "690e5134-cb3a-44bb-8134-e7f4a0df25a3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "61eab310-bba7-4f4f-9818-324678476f9c",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "86f1990b-e72c-467b-8e53-203286b89312",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "1932e1a7-59b0-4b78-be98-86cef3a5b948",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "2025-10-14T19:26:51.261Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "a9d6c0bc-5b36-4f33-b667-1b6a72e40179",
"created_at": 1760470011.363311,
"updated_at": 1760470011.363311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c864ea4d-976b-48e8-b348-823bff22c5c9",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "653a0851-42cc-4c5a-aaae-62a4c70fde16",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "31721330-71ad-492f-b6b8-11bdb7bfb8ed",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "e516e7cb-c248-4842-836f-63f554c6f6e4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "0a9f89ce-02cc-473f-a0a7-58b064f613ba",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6abfb94b-8acf-4943-9b3e-c670f50d50e3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a874cb57-ecc7-4abd-a220-52cd1ed49e5e",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "28831a79-5621-4f6b-91f5-eadf17f6c063",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6a346bf6-c8bd-47be-9513-47104c7f61a4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "4b89a0cd-cde5-4053-97e5-ee4808d826dc",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c3f3aea6-563a-4e04-bdae-d40f9b83b1e0",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a45bb140-b49d-4121-a562-649b78a76208",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "d0f18e58-b11c-4c43-97cb-5c1f608c4965",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "3e20b751-a705-4eb8-ae61-116e89640e64",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "7f85b80e-9599-45ec-9702-332171aa2dc2",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "113a62c2-43c9-4ce4-970f-4ba380b6b5b6",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "fda5e090-7624-4d6a-9315-58dce7bed149",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "690e5134-cb3a-44bb-8134-e7f4a0df25a3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "61eab310-bba7-4f4f-9818-324678476f9c",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "86f1990b-e72c-467b-8e53-203286b89312",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "1932e1a7-59b0-4b78-be98-86cef3a5b948",
"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: 26230327-6253-45b5-a14e-ceb39ac82ed3
Response
200Body
{
"code": "OK",
"data": [
{
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "2025-10-14T19:26:51.261Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "a9d6c0bc-5b36-4f33-b667-1b6a72e40179",
"created_at": 1760470011.363311,
"updated_at": 1760470011.363311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c864ea4d-976b-48e8-b348-823bff22c5c9",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "653a0851-42cc-4c5a-aaae-62a4c70fde16",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "31721330-71ad-492f-b6b8-11bdb7bfb8ed",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "e516e7cb-c248-4842-836f-63f554c6f6e4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "0a9f89ce-02cc-473f-a0a7-58b064f613ba",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6abfb94b-8acf-4943-9b3e-c670f50d50e3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a874cb57-ecc7-4abd-a220-52cd1ed49e5e",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "28831a79-5621-4f6b-91f5-eadf17f6c063",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6a346bf6-c8bd-47be-9513-47104c7f61a4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "4b89a0cd-cde5-4053-97e5-ee4808d826dc",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c3f3aea6-563a-4e04-bdae-d40f9b83b1e0",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a45bb140-b49d-4121-a562-649b78a76208",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "d0f18e58-b11c-4c43-97cb-5c1f608c4965",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "3e20b751-a705-4eb8-ae61-116e89640e64",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "7f85b80e-9599-45ec-9702-332171aa2dc2",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "113a62c2-43c9-4ce4-970f-4ba380b6b5b6",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "fda5e090-7624-4d6a-9315-58dce7bed149",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "690e5134-cb3a-44bb-8134-e7f4a0df25a3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "61eab310-bba7-4f4f-9818-324678476f9c",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "86f1990b-e72c-467b-8e53-203286b89312",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "1932e1a7-59b0-4b78-be98-86cef3a5b948",
"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: 26230327-6253-45b5-a14e-ceb39ac82ed3
Response
200Body
{
"code": "OK",
"data": [
{
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "2025-10-14T19:26:51.261Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1760470016.789557,
"is_draft": false,
"roles": [
{
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "a9d6c0bc-5b36-4f33-b667-1b6a72e40179",
"created_at": 1760470011.363311,
"updated_at": 1760470011.363311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c864ea4d-976b-48e8-b348-823bff22c5c9",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "653a0851-42cc-4c5a-aaae-62a4c70fde16",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "31721330-71ad-492f-b6b8-11bdb7bfb8ed",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "e516e7cb-c248-4842-836f-63f554c6f6e4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "0a9f89ce-02cc-473f-a0a7-58b064f613ba",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6abfb94b-8acf-4943-9b3e-c670f50d50e3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a874cb57-ecc7-4abd-a220-52cd1ed49e5e",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "28831a79-5621-4f6b-91f5-eadf17f6c063",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6a346bf6-c8bd-47be-9513-47104c7f61a4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "4b89a0cd-cde5-4053-97e5-ee4808d826dc",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c3f3aea6-563a-4e04-bdae-d40f9b83b1e0",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a45bb140-b49d-4121-a562-649b78a76208",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "d0f18e58-b11c-4c43-97cb-5c1f608c4965",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "3e20b751-a705-4eb8-ae61-116e89640e64",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "7f85b80e-9599-45ec-9702-332171aa2dc2",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "113a62c2-43c9-4ce4-970f-4ba380b6b5b6",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "fda5e090-7624-4d6a-9315-58dce7bed149",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "690e5134-cb3a-44bb-8134-e7f4a0df25a3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "61eab310-bba7-4f4f-9818-324678476f9c",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "86f1990b-e72c-467b-8e53-203286b89312",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "1932e1a7-59b0-4b78-be98-86cef3a5b948",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "2025-10-14T19:26:51.261Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "a9d6c0bc-5b36-4f33-b667-1b6a72e40179",
"created_at": 1760470011.363311,
"updated_at": 1760470011.363311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c864ea4d-976b-48e8-b348-823bff22c5c9",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "653a0851-42cc-4c5a-aaae-62a4c70fde16",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "31721330-71ad-492f-b6b8-11bdb7bfb8ed",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "e516e7cb-c248-4842-836f-63f554c6f6e4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "0a9f89ce-02cc-473f-a0a7-58b064f613ba",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6abfb94b-8acf-4943-9b3e-c670f50d50e3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a874cb57-ecc7-4abd-a220-52cd1ed49e5e",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "28831a79-5621-4f6b-91f5-eadf17f6c063",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6a346bf6-c8bd-47be-9513-47104c7f61a4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "4b89a0cd-cde5-4053-97e5-ee4808d826dc",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c3f3aea6-563a-4e04-bdae-d40f9b83b1e0",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a45bb140-b49d-4121-a562-649b78a76208",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "d0f18e58-b11c-4c43-97cb-5c1f608c4965",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "3e20b751-a705-4eb8-ae61-116e89640e64",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "7f85b80e-9599-45ec-9702-332171aa2dc2",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "113a62c2-43c9-4ce4-970f-4ba380b6b5b6",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "fda5e090-7624-4d6a-9315-58dce7bed149",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "690e5134-cb3a-44bb-8134-e7f4a0df25a3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "61eab310-bba7-4f4f-9818-324678476f9c",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "86f1990b-e72c-467b-8e53-203286b89312",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "1932e1a7-59b0-4b78-be98-86cef3a5b948",
"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": "eb0e3684-96e6-496b-a46b-2ca06852b3a7"
}Response
200Body
{
"code": "OK",
"data": {
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "bbbe25aa-a933-11f0-9403-f6bc7f79063b",
"created_at": 1760470010.671251,
"updated_at": 1760470010.671252,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"created_at": 1760470010.40747,
"updated_at": 1760470010.40747,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "6d9d963d-3fcb-493d-9da9-e00ff56e3dbc",
"created_at": 1760470009.20996,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "ebb3a5c1-4bd9-4954-aa46-d24ba1a2d6bb",
"created_at": 1760470009.20996,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "4f61cacd-297d-45f1-8b11-30862e16563b",
"created_at": 1760470009.20996,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "a9d6c0bc-5b36-4f33-b667-1b6a72e40179",
"created_at": 1760470011.363311,
"updated_at": 1760470011.363311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- rid
string(required) Example: 7a853355-beda-42f6-9850-1bcb7bdb3215
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215"
}Response
200Body
{
"code": "OK",
"data": {
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c864ea4d-976b-48e8-b348-823bff22c5c9",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "653a0851-42cc-4c5a-aaae-62a4c70fde16",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "31721330-71ad-492f-b6b8-11bdb7bfb8ed",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "e516e7cb-c248-4842-836f-63f554c6f6e4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "0a9f89ce-02cc-473f-a0a7-58b064f613ba",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6abfb94b-8acf-4943-9b3e-c670f50d50e3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a874cb57-ecc7-4abd-a220-52cd1ed49e5e",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "28831a79-5621-4f6b-91f5-eadf17f6c063",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6a346bf6-c8bd-47be-9513-47104c7f61a4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "4b89a0cd-cde5-4053-97e5-ee4808d826dc",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c3f3aea6-563a-4e04-bdae-d40f9b83b1e0",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a45bb140-b49d-4121-a562-649b78a76208",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "d0f18e58-b11c-4c43-97cb-5c1f608c4965",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "3e20b751-a705-4eb8-ae61-116e89640e64",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "7f85b80e-9599-45ec-9702-332171aa2dc2",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "113a62c2-43c9-4ce4-970f-4ba380b6b5b6",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "fda5e090-7624-4d6a-9315-58dce7bed149",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "690e5134-cb3a-44bb-8134-e7f4a0df25a3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "61eab310-bba7-4f4f-9818-324678476f9c",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "86f1990b-e72c-467b-8e53-203286b89312",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "1932e1a7-59b0-4b78-be98-86cef3a5b948",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7"
}Response
200Body
{
"code": "OK",
"data": {
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"created_at": 1760470010.40747,
"updated_at": 1760470010.40747,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "6d9d963d-3fcb-493d-9da9-e00ff56e3dbc",
"created_at": 1760470009.20996,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "ebb3a5c1-4bd9-4954-aa46-d24ba1a2d6bb",
"created_at": 1760470009.20996,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "4f61cacd-297d-45f1-8b11-30862e16563b",
"created_at": 1760470009.20996,
"deleted_at": null,
"brand": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c864ea4d-976b-48e8-b348-823bff22c5c9",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "653a0851-42cc-4c5a-aaae-62a4c70fde16",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "31721330-71ad-492f-b6b8-11bdb7bfb8ed",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "e516e7cb-c248-4842-836f-63f554c6f6e4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "0a9f89ce-02cc-473f-a0a7-58b064f613ba",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6abfb94b-8acf-4943-9b3e-c670f50d50e3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a874cb57-ecc7-4abd-a220-52cd1ed49e5e",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "28831a79-5621-4f6b-91f5-eadf17f6c063",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "6a346bf6-c8bd-47be-9513-47104c7f61a4",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "4b89a0cd-cde5-4053-97e5-ee4808d826dc",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "c3f3aea6-563a-4e04-bdae-d40f9b83b1e0",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "a45bb140-b49d-4121-a562-649b78a76208",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "d0f18e58-b11c-4c43-97cb-5c1f608c4965",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "3e20b751-a705-4eb8-ae61-116e89640e64",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "7f85b80e-9599-45ec-9702-332171aa2dc2",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "113a62c2-43c9-4ce4-970f-4ba380b6b5b6",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "fda5e090-7624-4d6a-9315-58dce7bed149",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "690e5134-cb3a-44bb-8134-e7f4a0df25a3",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "61eab310-bba7-4f4f-9818-324678476f9c",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "86f1990b-e72c-467b-8e53-203286b89312",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "MLS",
"definition": "1932e1a7-59b0-4b78-be98-86cef3a5b948",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Request
Body
{
"context": [
{
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"value": "2017/12/06"
},
{
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- cid
string(required) Example: 4163976a-42a7-4f13-990a-036341cc2cd1
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_at": 1760470010.671131,
"updated_at": 1760470010.671131,
"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": "e010eeac-d6b3-464e-a2c6-09ee772987a2",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "690f5e7a-df25-4432-991d-69c5e4e26f36",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": null,
"source": "PropertyType",
"definition": "d798bedf-681c-4d25-a2af-fc872a223193",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": "2025-10-14T19:26:49.20996+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-10-14T19:26:50.976781+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"source": "Provided",
"definition": "e54d2dcc-bd08-48e4-a3b2-c11a7dbe2a5d",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "4163976a-42a7-4f13-990a-036341cc2cd1",
"type": "deal_context_item",
"created_at": 1760470009.20996,
"approved_at": 1760470010.976781,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7"
}
],
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "7a853355-beda-42f6-9850-1bcb7bdb3215",
"created_at": 1760470011.359463,
"updated_at": 1760470011.359463,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "a9d6c0bc-5b36-4f33-b667-1b6a72e40179",
"created_at": 1760470011.363311,
"updated_at": 1760470011.363311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- rid
string(required) Example: 7a853355-beda-42f6-9850-1bcb7bdb3215
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "eb0e3684-96e6-496b-a46b-2ca06852b3a7"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"created_at": 1760470009.20996,
"updated_at": 1760470009.20996,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"order": 1,
"origin": "4f61cacd-297d-45f1-8b11-30862e16563b",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- cid
string(required) Example: 8d15d88b-2857-46d7-a1f3-5843779b5ab7
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "8d15d88b-2857-46d7-a1f3-5843779b5ab7"
}Response
200Body
{
"code": "OK",
"data": {
"id": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"created_at": 1760470009.20996,
"updated_at": 1760470009.20996,
"deleted_at": null,
"deactivated_at": "2025-10-14T19:26:57.261Z",
"title": "Updated Checklist 1",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"order": 3,
"origin": "4f61cacd-297d-45f1-8b11-30862e16563b",
"terminated_at": "2025-10-14T19:26:57.261Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "22d0300a-125d-4060-bc58-99a544806ad9",
"created_at": 1760470012.205309,
"updated_at": 1760470017.109004,
"room": {
"type": "room",
"id": "66197493-0b79-4183-a8a5-44a10f7cad37",
"title": "5020 Junius Street: Test Title",
"created_at": 1760470012.185951,
"updated_at": 1760470016.737062,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "299a9e7e-915c-4f1b-a1a7-1ae23d993198",
"last_revision": "4d2466b4-d54b-4ba9-a35a-1c12fc4e4ed3",
"state": "Fair",
"created_at": 1760470015.193937,
"updated_at": 1760470015.738278,
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b3e224e2-cadf-49e1-aa34-80ef809c976d",
"created_at": 1760470015.763083,
"updated_at": 1760470015.763084,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556415770&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=TDteFqHhlaMDfDabdkSzhsrEXM0KuBAu-~oepL-uzHnMq72BQ0udl4r9UpvxeFfkb6FEls46M09Z3KPItSPTwAMG7OPNMzH~rdBn98qGtVnby0B4oUGuM0BrOWkkXIsYWfXoJfUcp-IjARlDKZf5efXSAyytVcoaRpxb-EUt9KqAJqoFxAfQ1UyZCsf5Y2Bfpz9nQQm2EuBOZDaIV-0dqK4lLrxx61srcLHrkvpeidu2oMmdRcVYEK5hWZDIqnZRttHBxj9m4ZhCb2TshODblAOM16IobjMkDP9SF2kwUf6p-CyE02OEv1NH0~8alXnzbCrfRZkf6Zuk6g7IUN3Fkw__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "e830ac29-79eb-4e97-8290-4a4dd823ab02",
"created_at": 1760470016.19017,
"type": "review",
"status": "Declined",
"updated_at": 1760470016.190675
},
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/22d0300a-125d-4060-bc58-99a544806ad9/submission.pdf?hash=jFzZqXtHACj12Y%2FXQ2BzVK1rh7iYcBmLXTBaY98BNCrEAn0vS4WQ4%2BBJyHoZB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXilAup0eUIATg%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: 22d0300a-125d-4060-bc58-99a544806ad9
Response
200Body
{
"code": "OK",
"data": {
"id": "22d0300a-125d-4060-bc58-99a544806ad9",
"created_at": 1760470012.205309,
"updated_at": 1760470015.241355,
"room": {
"type": "room",
"id": "66197493-0b79-4183-a8a5-44a10f7cad37",
"title": "5020 Junius Street: Test Title",
"created_at": 1760470012.185951,
"updated_at": 1760470015.979173,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "299a9e7e-915c-4f1b-a1a7-1ae23d993198",
"last_revision": "4d2466b4-d54b-4ba9-a35a-1c12fc4e4ed3",
"state": "Fair",
"created_at": 1760470015.193937,
"updated_at": 1760470015.738278,
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b3e224e2-cadf-49e1-aa34-80ef809c976d",
"created_at": 1760470015.763083,
"updated_at": 1760470015.763084,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556415770&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=TDteFqHhlaMDfDabdkSzhsrEXM0KuBAu-~oepL-uzHnMq72BQ0udl4r9UpvxeFfkb6FEls46M09Z3KPItSPTwAMG7OPNMzH~rdBn98qGtVnby0B4oUGuM0BrOWkkXIsYWfXoJfUcp-IjARlDKZf5efXSAyytVcoaRpxb-EUt9KqAJqoFxAfQ1UyZCsf5Y2Bfpz9nQQm2EuBOZDaIV-0dqK4lLrxx61srcLHrkvpeidu2oMmdRcVYEK5hWZDIqnZRttHBxj9m4ZhCb2TshODblAOM16IobjMkDP9SF2kwUf6p-CyE02OEv1NH0~8alXnzbCrfRZkf6Zuk6g7IUN3Fkw__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/22d0300a-125d-4060-bc58-99a544806ad9/submission.pdf?hash=jFzZqXtHACj12Y%2FXQ2BzVK1rh7iYcBmLXTBaY98BNCrEAn0vS4WQ4%2BBJyHoZB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXikAuhwf0IATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"is_deletable": true,
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "66197493-0b79-4183-a8a5-44a10f7cad37"
}Response
200Body
{
"code": "OK",
"data": {
"id": "22d0300a-125d-4060-bc58-99a544806ad9",
"created_at": 1760470012.205309,
"updated_at": 1760470012.205309,
"room": {
"type": "room",
"id": "66197493-0b79-4183-a8a5-44a10f7cad37",
"title": "5020 Junius Street: Test Title",
"created_at": 1760470012.185951,
"updated_at": 1760470012.309239,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/22d0300a-125d-4060-bc58-99a544806ad9/submission.pdf?hash=jFzZqXtHACj12Y%2FXQ2BzVK1rh7iYcBmLXTBaY98BNCrEAn0vS4WQ4%2BBJyHoZB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXigAu13ekIATg%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: 22d0300a-125d-4060-bc58-99a544806ad9
Request
Body
{
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"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": "299a9e7e-915c-4f1b-a1a7-1ae23d993198",
"last_revision": "144a21dc-8768-4191-8b8e-3496217d64ed",
"state": "Fair",
"created_at": 1760470015.193937,
"updated_at": 1760470015.450629,
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "9c48f875-9bdc-4829-a966-484344d0e135",
"created_at": 1760470015.474572,
"updated_at": 1760470015.474572,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/22d0300a-125d-4060-bc58-99a544806ad9/be983e00-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/22d0300a-125d-4060-bc58-99a544806ad9/be983e00-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556415479&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PTZvt60oPEWN-Gfs~8j4aZLEexG51-HiCC3zP9GyG59Rzu~NUVV~k4etUMkqAhyAjFe-ra-sX1fXmuEqolwJhjociWh9d7vbGyRmwgV9Z9YhorqYy2hY09UZ3awYgfpTrzEumDUVKv~aHFF4pGkgVrYgLZed7AmZk1-7iXLAuj-MQOWmLas5PbC63B4DwBHmLsOpLCoArfueO2c2zcbIZxpALj6vy~BpwdfTJtFAbPdCXnbySuo1jo5TPtQVUTtsit~uZUL69d7XjcQrPEhgcP9ehvVAVv7awzZ0KMLrD3aWBHaksJvBgBNY53aIHkxMth4XVKzstPk40~npmATryg__",
"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: 22d0300a-125d-4060-bc58-99a544806ad9- revision
string(required) Example: 144a21dc-8768-4191-8b8e-3496217d64ed
Response
200Body
{
"code": "OK",
"data": {
"id": "144a21dc-8768-4191-8b8e-3496217d64ed",
"submission": "299a9e7e-915c-4f1b-a1a7-1ae23d993198",
"created_at": 1760470015.193937,
"updated_at": 1760470015.450629,
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "9c48f875-9bdc-4829-a966-484344d0e135"
}
}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: 22d0300a-125d-4060-bc58-99a544806ad9
Request
Body
{
"status": "Declined",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "22d0300a-125d-4060-bc58-99a544806ad9",
"created_at": 1760470012.205309,
"updated_at": 1760470016.195286,
"room": {
"type": "room",
"id": "66197493-0b79-4183-a8a5-44a10f7cad37",
"title": "5020 Junius Street: Test Title",
"created_at": 1760470012.185951,
"updated_at": 1760470016.239422,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "299a9e7e-915c-4f1b-a1a7-1ae23d993198",
"last_revision": "4d2466b4-d54b-4ba9-a35a-1c12fc4e4ed3",
"state": "Fair",
"created_at": 1760470015.193937,
"updated_at": 1760470015.738278,
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b3e224e2-cadf-49e1-aa34-80ef809c976d",
"created_at": 1760470015.763083,
"updated_at": 1760470015.763084,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556415770&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=TDteFqHhlaMDfDabdkSzhsrEXM0KuBAu-~oepL-uzHnMq72BQ0udl4r9UpvxeFfkb6FEls46M09Z3KPItSPTwAMG7OPNMzH~rdBn98qGtVnby0B4oUGuM0BrOWkkXIsYWfXoJfUcp-IjARlDKZf5efXSAyytVcoaRpxb-EUt9KqAJqoFxAfQ1UyZCsf5Y2Bfpz9nQQm2EuBOZDaIV-0dqK4lLrxx61srcLHrkvpeidu2oMmdRcVYEK5hWZDIqnZRttHBxj9m4ZhCb2TshODblAOM16IobjMkDP9SF2kwUf6p-CyE02OEv1NH0~8alXnzbCrfRZkf6Zuk6g7IUN3Fkw__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "e830ac29-79eb-4e97-8290-4a4dd823ab02",
"created_at": 1760470016.19017,
"type": "review",
"status": "Declined",
"updated_at": 1760470016.190675
},
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/22d0300a-125d-4060-bc58-99a544806ad9/submission.pdf?hash=jFzZqXtHACj12Y%2FXQ2BzVK1rh7iYcBmLXTBaY98BNCrEAn0vS4WQ4%2BBJyHoZB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXikAup0d0IATg%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: 22d0300a-125d-4060-bc58-99a544806ad9
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "22d0300a-125d-4060-bc58-99a544806ad9",
"created_at": 1760470012.205309,
"updated_at": 1760470016.789557,
"room": {
"type": "room",
"id": "66197493-0b79-4183-a8a5-44a10f7cad37",
"title": "5020 Junius Street: Test Title",
"created_at": 1760470012.185951,
"updated_at": 1760470016.737062,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "299a9e7e-915c-4f1b-a1a7-1ae23d993198",
"last_revision": "4d2466b4-d54b-4ba9-a35a-1c12fc4e4ed3",
"state": "Fair",
"created_at": 1760470015.193937,
"updated_at": 1760470015.738278,
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b3e224e2-cadf-49e1-aa34-80ef809c976d",
"created_at": 1760470015.763083,
"updated_at": 1760470015.763084,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/22d0300a-125d-4060-bc58-99a544806ad9/bec43000-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556415770&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=TDteFqHhlaMDfDabdkSzhsrEXM0KuBAu-~oepL-uzHnMq72BQ0udl4r9UpvxeFfkb6FEls46M09Z3KPItSPTwAMG7OPNMzH~rdBn98qGtVnby0B4oUGuM0BrOWkkXIsYWfXoJfUcp-IjARlDKZf5efXSAyytVcoaRpxb-EUt9KqAJqoFxAfQ1UyZCsf5Y2Bfpz9nQQm2EuBOZDaIV-0dqK4lLrxx61srcLHrkvpeidu2oMmdRcVYEK5hWZDIqnZRttHBxj9m4ZhCb2TshODblAOM16IobjMkDP9SF2kwUf6p-CyE02OEv1NH0~8alXnzbCrfRZkf6Zuk6g7IUN3Fkw__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "e830ac29-79eb-4e97-8290-4a4dd823ab02",
"created_at": 1760470016.19017,
"type": "review",
"status": "Declined",
"updated_at": 1760470016.190675
},
"form": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2025-10-14T19:26:56.789Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/22d0300a-125d-4060-bc58-99a544806ad9/submission.pdf?hash=jFzZqXtHACj12Y%2FXQ2BzVK1rh7iYcBmLXTBaY98BNCrEAn0vS4WQ4%2BBJyHoZB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXikAuF6fUIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: c20707de-281b-44dc-9d74-49f340d734f0
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "c20707de-281b-44dc-9d74-49f340d734f0",
"created_at": 1760470012.53112,
"updated_at": 1760470013.226062,
"room": {
"type": "room",
"id": "aeac487b-008a-4cd2-b166-b862094aef00",
"title": "5020 Junius Street: Another Task",
"created_at": 1760470012.517302,
"updated_at": 1760470012.657086,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/c20707de-281b-44dc-9d74-49f340d734f0/submission.pdf?hash=jFzZqXtHACj1iI%2BDRGN0AKlrhLKcdhmLWWIJY4QGNibED30oTYWUv%2BdMnXgQB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXihAupzd0IATg%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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Request
Body
[
{
"id": "22d0300a-125d-4060-bc58-99a544806ad9",
"title": "Bulk Test Title"
},
{
"id": "c20707de-281b-44dc-9d74-49f340d734f0",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "22d0300a-125d-4060-bc58-99a544806ad9",
"created_at": 1760470012.205309,
"updated_at": 1760470013.420763,
"room": {
"type": "room",
"id": "66197493-0b79-4183-a8a5-44a10f7cad37",
"title": "5020 Junius Street: Test Title",
"created_at": 1760470012.185951,
"updated_at": 1760470013.044525,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"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": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/22d0300a-125d-4060-bc58-99a544806ad9/submission.pdf?hash=jFzZqXtHACj12Y%2FXQ2BzVK1rh7iYcBmLXTBaY98BNCrEAn0vS4WQ4%2BBJyHoZB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXihAu5xdkIATg%3D%3D"
},
{
"id": "c20707de-281b-44dc-9d74-49f340d734f0",
"created_at": 1760470012.53112,
"updated_at": 1760470013.593036,
"room": {
"type": "room",
"id": "aeac487b-008a-4cd2-b166-b862094aef00",
"title": "5020 Junius Street: Another Task",
"created_at": 1760470012.517302,
"updated_at": 1760470013.505872,
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"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": "c9ec0e98-5168-4e48-b7a7-1ed3172fb527",
"checklist": "8d15d88b-2857-46d7-a1f3-5843779b5ab7",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2025-10-14T19:26:53.593Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "8351e565-8144-4d1d-90c8-cc2af4da9a23",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/c20707de-281b-44dc-9d74-49f340d734f0/submission.pdf?hash=jFzZqXtHACj1iI%2BDRGN0AKlrhLKcdhmLWWIJY4QGNibED30oTYWUv%2BdMnXgQB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR9aA2kJG3Hu8ozpXihAu5xdkIATg%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: 22d0300a-125d-4060-bc58-99a544806ad9
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "9c48f875-9bdc-4829-a966-484344d0e135"
}Response
200Body
{
"code": "OK",
"data": {
"id": "ad3fe68a-ed90-4213-af4e-5d68835c6207",
"reference": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"reference_type": "User",
"created_at": 1760470015.96118,
"updated_at": 1760470015.96118,
"deleted_at": null,
"object": {
"id": "9c48f875-9bdc-4829-a966-484344d0e135",
"created_at": 1760470015.474572,
"updated_at": 1760470015.474572,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/22d0300a-125d-4060-bc58-99a544806ad9/be983e00-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/22d0300a-125d-4060-bc58-99a544806ad9/be983e00-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556415479&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PTZvt60oPEWN-Gfs~8j4aZLEexG51-HiCC3zP9GyG59Rzu~NUVV~k4etUMkqAhyAjFe-ra-sX1fXmuEqolwJhjociWh9d7vbGyRmwgV9Z9YhorqYy2hY09UZ3awYgfpTrzEumDUVKv~aHFF4pGkgVrYgLZed7AmZk1-7iXLAuj-MQOWmLas5PbC63B4DwBHmLsOpLCoArfueO2c2zcbIZxpALj6vy~BpwdfTJtFAbPdCXnbySuo1jo5TPtQVUTtsit~uZUL69d7XjcQrPEhgcP9ehvVAVv7awzZ0KMLrD3aWBHaksJvBgBNY53aIHkxMth4XVKzstPk40~npmATryg__",
"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: 22d0300a-125d-4060-bc58-99a544806ad9
Request
Body
{
"comment": "Comment",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "66197493-0b79-4183-a8a5-44a10f7cad37"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "4b0f313f-71fa-48cb-aef5-2e2b03e947cc",
"id": "4b0f313f-71fa-48cb-aef5-2e2b03e947cc",
"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": 1760470009.20996,
"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": null,
"current_time": "2:26 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "3c3c5caf-2dfe-4210-9625-b378197a7b4a",
"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": 1760470009.364605,
"deleted_at": null,
"created_at": 1760470009.364605,
"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": "26230327-6253-45b5-a14e-ceb39ac82ed3",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"created_at": 1760470017.464615,
"updated_at": 1760470017.464615,
"room": "66197493-0b79-4183-a8a5-44a10f7cad37",
"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: c20707de-281b-44dc-9d74-49f340d734f0
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Response
200Body
{
"code": "OK",
"data": {
"id": "ff52a808-1d99-4ecf-994e-ce95fae0c758",
"created_at": 1760470018.153269,
"updated_at": 1760470018.153269,
"deleted_at": null,
"gallery": "bbbe25aa-a933-11f0-9403-f6bc7f79063b",
"name": null,
"order": 0,
"file": {
"id": "5dcef202-cf00-4e78-82d3-f76bb04b9790",
"created_at": 1760470018.144271,
"updated_at": 1760470018.144271,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "8351e565-8144-4d1d-90c8-cc2af4da9a23/c031c9c0-a933-11f0-bdea-d5cf17ea076e.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/8351e565-8144-4d1d-90c8-cc2af4da9a23/c031c9c0-a933-11f0-bdea-d5cf17ea076e.png",
"preview_url": "https://test.cloudfront.net/8351e565-8144-4d1d-90c8-cc2af4da9a23/c031c9c0-a933-11f0-bdea-d5cf17ea076e.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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- iid
string(required) Example: ff52a808-1d99-4ecf-994e-ce95fae0c758
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "5dcef202-cf00-4e78-82d3-f76bb04b9790"
}Response
200Body
{
"code": "OK",
"data": {
"id": "ff52a808-1d99-4ecf-994e-ce95fae0c758",
"created_at": 1760470018.153269,
"updated_at": 1760470009.20996,
"deleted_at": null,
"gallery": "bbbe25aa-a933-11f0-9403-f6bc7f79063b",
"name": "Updated Name",
"order": 2,
"file": {
"id": "5dcef202-cf00-4e78-82d3-f76bb04b9790",
"created_at": 1760470018.144271,
"updated_at": 1760470018.144271,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "8351e565-8144-4d1d-90c8-cc2af4da9a23/c031c9c0-a933-11f0-bdea-d5cf17ea076e.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/8351e565-8144-4d1d-90c8-cc2af4da9a23/c031c9c0-a933-11f0-bdea-d5cf17ea076e.png",
"preview_url": "https://test.cloudfront.net/8351e565-8144-4d1d-90c8-cc2af4da9a23/c031c9c0-a933-11f0-bdea-d5cf17ea076e.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: 8351e565-8144-4d1d-90c8-cc2af4da9a23- iid
string(required) Example: ff52a808-1d99-4ecf-994e-ce95fae0c758
Response
200Body
{
"code": "OK",
"data": {
"id": "ff52a808-1d99-4ecf-994e-ce95fae0c758",
"created_at": 1760470018.153269,
"updated_at": 1760470009.20996,
"deleted_at": null,
"gallery": "bbbe25aa-a933-11f0-9403-f6bc7f79063b",
"name": "Updated Name",
"order": 2,
"file": {
"id": "9eac7519-32d3-4ed9-ac5e-d6a371360429",
"created_at": 1760470018.243928,
"updated_at": 1760470018.243928,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "8351e565-8144-4d1d-90c8-cc2af4da9a23/c0410c00-a933-11f0-bdea-d5cf17ea076e.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/8351e565-8144-4d1d-90c8-cc2af4da9a23/c0410c00-a933-11f0-bdea-d5cf17ea076e.png?Expires=1760556418248&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MNKUiom59aNwB90w7yW4r0pqZwCjt~nf~yg1-iqCAJrlSJ2M3LWDwuh0k4vFIf4GHaT1nQtPN1JPcG7Ad4qk2XkRPx19FjOjjvqMgfjiSwgKDXpP~5oVPFYejBDfyw-lflTYYJn5Hyuut3x-snT8Z0~sCHfL8DYWmqdZMDV2au5EvdGNGrtVFUXZMat2dY4NqN~ewhEskjzf3DOcgQSn89Xe6sVdQ0xqXC-iUfjlLBh-Fz~~gP~mBqMty2ovFTl0JOfsBckaewdliSACjoQlQ7y2A~bZfgfF5HdMKcJUa~uHFDudTSTSaX9E~~P6lgtNWTgFk9VGo0MQ5XGHx~kzow__",
"preview_url": "https://private-cdn.irish.rechat.com/8351e565-8144-4d1d-90c8-cc2af4da9a23/c0410c00-a933-11f0-bdea-d5cf17ea076e.png?Expires=1760556418248&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MNKUiom59aNwB90w7yW4r0pqZwCjt~nf~yg1-iqCAJrlSJ2M3LWDwuh0k4vFIf4GHaT1nQtPN1JPcG7Ad4qk2XkRPx19FjOjjvqMgfjiSwgKDXpP~5oVPFYejBDfyw-lflTYYJn5Hyuut3x-snT8Z0~sCHfL8DYWmqdZMDV2au5EvdGNGrtVFUXZMat2dY4NqN~ewhEskjzf3DOcgQSn89Xe6sVdQ0xqXC-iUfjlLBh-Fz~~gP~mBqMty2ovFTl0JOfsBckaewdliSACjoQlQ7y2A~bZfgfF5HdMKcJUa~uHFDudTSTSaX9E~~P6lgtNWTgFk9VGo0MQ5XGHx~kzow__",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Request
Body
[
{
"id": "ff52a808-1d99-4ecf-994e-ce95fae0c758",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "ff52a808-1d99-4ecf-994e-ce95fae0c758",
"created_at": 1760470018.153269,
"updated_at": 1760470009.20996,
"deleted_at": 1760470009.20996,
"gallery": "bbbe25aa-a933-11f0-9403-f6bc7f79063b",
"name": "Updated Name",
"order": 3,
"file": {
"id": "9eac7519-32d3-4ed9-ac5e-d6a371360429",
"created_at": 1760470018.243928,
"updated_at": 1760470018.243928,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "8351e565-8144-4d1d-90c8-cc2af4da9a23/c0410c00-a933-11f0-bdea-d5cf17ea076e.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/8351e565-8144-4d1d-90c8-cc2af4da9a23/c0410c00-a933-11f0-bdea-d5cf17ea076e.png?Expires=1760556418248&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MNKUiom59aNwB90w7yW4r0pqZwCjt~nf~yg1-iqCAJrlSJ2M3LWDwuh0k4vFIf4GHaT1nQtPN1JPcG7Ad4qk2XkRPx19FjOjjvqMgfjiSwgKDXpP~5oVPFYejBDfyw-lflTYYJn5Hyuut3x-snT8Z0~sCHfL8DYWmqdZMDV2au5EvdGNGrtVFUXZMat2dY4NqN~ewhEskjzf3DOcgQSn89Xe6sVdQ0xqXC-iUfjlLBh-Fz~~gP~mBqMty2ovFTl0JOfsBckaewdliSACjoQlQ7y2A~bZfgfF5HdMKcJUa~uHFDudTSTSaX9E~~P6lgtNWTgFk9VGo0MQ5XGHx~kzow__",
"preview_url": "https://private-cdn.irish.rechat.com/8351e565-8144-4d1d-90c8-cc2af4da9a23/c0410c00-a933-11f0-bdea-d5cf17ea076e.png?Expires=1760556418248&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MNKUiom59aNwB90w7yW4r0pqZwCjt~nf~yg1-iqCAJrlSJ2M3LWDwuh0k4vFIf4GHaT1nQtPN1JPcG7Ad4qk2XkRPx19FjOjjvqMgfjiSwgKDXpP~5oVPFYejBDfyw-lflTYYJn5Hyuut3x-snT8Z0~sCHfL8DYWmqdZMDV2au5EvdGNGrtVFUXZMat2dY4NqN~ewhEskjzf3DOcgQSn89Xe6sVdQ0xqXC-iUfjlLBh-Fz~~gP~mBqMty2ovFTl0JOfsBckaewdliSACjoQlQ7y2A~bZfgfF5HdMKcJUa~uHFDudTSTSaX9E~~P6lgtNWTgFk9VGo0MQ5XGHx~kzow__",
"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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Request
Body
{
"items": [
"ff52a808-1d99-4ecf-994e-ce95fae0c758"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/bbbe25aa-a933-11f0-9403-f6bc7f79063b.zip?hash=jFzKqWRAR2CuyYeRETEhAf5z1%2BuAdQ2MXitbf9tSLCvdC3djGIfGuOcZnicQE3fnkxDSPuwS29FDCKVDtEbmgEfBX7kWJ5cSkh3puldnfF9wg5WxjiM9LFcybr1WdrfQEGPBAzRU3EZ2R6d4aA2gXW3K1ck8pX%2BkFux7YCsbB1KFCeqzv8aof7YNuyTo03HEhz0fADhNshLT1X0ksOsj8D8n4PckR1AGrWeaXEVrqSGbE7M%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: 8351e565-8144-4d1d-90c8-cc2af4da9a23
Response
200Body
{
"code": "OK",
"data": {
"id": "45ff4594-ae24-464e-82f6-1bb095ee660f",
"created_at": 1760470018.592909,
"updated_at": 1760470018.592909,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/8351e565-8144-4d1d-90c8-cc2af4da9a23/c0749f20-a933-11f0-bdea-d5cf17ea076e.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/8351e565-8144-4d1d-90c8-cc2af4da9a23/c0749f20-a933-11f0-bdea-d5cf17ea076e.zip?Expires=1760556418598&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=M-IqgDisXZq9gYZ97jfl1zZjEiwsKJqe1DIUKOA5giHLPBalu2oGhmJCtv9GDnll~NpaMW8IUILLPcJAuSlL4kO-TXn7fL4qctMsekX-lw9zmxhdS0X8Q5x6I9DZZKv52Harm9cqN5U1ltvIpWMfXYZaWH8uZvWQ0zQ0S0RZpvMrkfpQbBsxslNd9VYS9uJwQreMx5p-9IJEpW2gq1MaH3xRofcSCPDcCMsDIQBQjYA~T-lIyygAwokzGxrAjxLyz-49HTMmHpRZgop3y9zfX7RjKBqH2JsF7iEg1FJmTJMELut~oVrCx1N5rvzk8nBZdZEaz9daIsjxb6KbDTdByA__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}