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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Response
200Body
{
"code": "OK",
"data": {
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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-12-08T03:12:02.964Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "1454c4aa-b68d-4e54-b4c5-97ce626d9b0c",
"created_at": 1765163523.090599,
"updated_at": 1765163523.090599,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2da056c7-ef61-4f9d-8148-b8ad699d3d4c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7faa3278-15ff-4c29-8827-461934a98bde",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "cc91115a-8c28-4723-9b6a-f05c2afcefae",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "b5be91cf-e0fe-450a-8f56-79efea81307e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c2eaedc0-7f95-4831-9f68-31a323e41c5c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "eaad7eec-4d6f-420e-98a9-b56fe7038d52",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7e7fb683-09b7-474b-a234-59281ef33f5f",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e9979910-bf39-4444-bd29-b1519eb1c144",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "726386b0-b0c5-4738-999d-533b94015381",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e595d1e2-6a8e-4aa7-b466-eb9beb1a4858",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "55458923-9613-46ac-82e1-a1176633d01a",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "48513580-bce2-4456-8986-79ccd906cd53",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2474a79f-52c4-4e7d-90ac-446440561de2",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "f0b5dbcc-3ffa-42c9-9df0-ffbf8d386c14",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "341aea77-2714-4ab9-994d-8433a4beb1bc",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2c6e15f8-e830-4253-8f6e-372f559bacd0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c9823a97-4183-42f9-8102-92686a5e237c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "498321d7-f785-4311-8e08-442287026440",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "3a336eb2-640a-4c8b-943d-92d90b34ced0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "1de6d396-1547-486d-b264-fbba4ba7b39e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "5c19c91e-9cf6-4fc5-836c-c9de8ae15377",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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-12-08T03:12:02.964Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "1454c4aa-b68d-4e54-b4c5-97ce626d9b0c",
"created_at": 1765163523.090599,
"updated_at": 1765163523.090599,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2da056c7-ef61-4f9d-8148-b8ad699d3d4c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7faa3278-15ff-4c29-8827-461934a98bde",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "cc91115a-8c28-4723-9b6a-f05c2afcefae",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "b5be91cf-e0fe-450a-8f56-79efea81307e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c2eaedc0-7f95-4831-9f68-31a323e41c5c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "eaad7eec-4d6f-420e-98a9-b56fe7038d52",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7e7fb683-09b7-474b-a234-59281ef33f5f",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e9979910-bf39-4444-bd29-b1519eb1c144",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "726386b0-b0c5-4738-999d-533b94015381",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e595d1e2-6a8e-4aa7-b466-eb9beb1a4858",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "55458923-9613-46ac-82e1-a1176633d01a",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "48513580-bce2-4456-8986-79ccd906cd53",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2474a79f-52c4-4e7d-90ac-446440561de2",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "f0b5dbcc-3ffa-42c9-9df0-ffbf8d386c14",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "341aea77-2714-4ab9-994d-8433a4beb1bc",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2c6e15f8-e830-4253-8f6e-372f559bacd0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c9823a97-4183-42f9-8102-92686a5e237c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "498321d7-f785-4311-8e08-442287026440",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "3a336eb2-640a-4c8b-943d-92d90b34ced0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "1de6d396-1547-486d-b264-fbba4ba7b39e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "5c19c91e-9cf6-4fc5-836c-c9de8ae15377",
"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: bf213a9f-2514-4ee4-ab1d-32b834651e23
Response
200Body
{
"code": "OK",
"data": [
{
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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-12-08T03:12:02.964Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "1454c4aa-b68d-4e54-b4c5-97ce626d9b0c",
"created_at": 1765163523.090599,
"updated_at": 1765163523.090599,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2da056c7-ef61-4f9d-8148-b8ad699d3d4c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7faa3278-15ff-4c29-8827-461934a98bde",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "cc91115a-8c28-4723-9b6a-f05c2afcefae",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "b5be91cf-e0fe-450a-8f56-79efea81307e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c2eaedc0-7f95-4831-9f68-31a323e41c5c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "eaad7eec-4d6f-420e-98a9-b56fe7038d52",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7e7fb683-09b7-474b-a234-59281ef33f5f",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e9979910-bf39-4444-bd29-b1519eb1c144",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "726386b0-b0c5-4738-999d-533b94015381",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e595d1e2-6a8e-4aa7-b466-eb9beb1a4858",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "55458923-9613-46ac-82e1-a1176633d01a",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "48513580-bce2-4456-8986-79ccd906cd53",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2474a79f-52c4-4e7d-90ac-446440561de2",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "f0b5dbcc-3ffa-42c9-9df0-ffbf8d386c14",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "341aea77-2714-4ab9-994d-8433a4beb1bc",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2c6e15f8-e830-4253-8f6e-372f559bacd0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c9823a97-4183-42f9-8102-92686a5e237c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "498321d7-f785-4311-8e08-442287026440",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "3a336eb2-640a-4c8b-943d-92d90b34ced0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "1de6d396-1547-486d-b264-fbba4ba7b39e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "5c19c91e-9cf6-4fc5-836c-c9de8ae15377",
"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: bf213a9f-2514-4ee4-ab1d-32b834651e23
Response
200Body
{
"code": "OK",
"data": [
{
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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-12-08T03:12:02.964Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1765163528.84145,
"is_draft": false,
"roles": [
{
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "1454c4aa-b68d-4e54-b4c5-97ce626d9b0c",
"created_at": 1765163523.090599,
"updated_at": 1765163523.090599,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2da056c7-ef61-4f9d-8148-b8ad699d3d4c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7faa3278-15ff-4c29-8827-461934a98bde",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "cc91115a-8c28-4723-9b6a-f05c2afcefae",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "b5be91cf-e0fe-450a-8f56-79efea81307e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c2eaedc0-7f95-4831-9f68-31a323e41c5c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "eaad7eec-4d6f-420e-98a9-b56fe7038d52",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7e7fb683-09b7-474b-a234-59281ef33f5f",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e9979910-bf39-4444-bd29-b1519eb1c144",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "726386b0-b0c5-4738-999d-533b94015381",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e595d1e2-6a8e-4aa7-b466-eb9beb1a4858",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "55458923-9613-46ac-82e1-a1176633d01a",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "48513580-bce2-4456-8986-79ccd906cd53",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2474a79f-52c4-4e7d-90ac-446440561de2",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "f0b5dbcc-3ffa-42c9-9df0-ffbf8d386c14",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "341aea77-2714-4ab9-994d-8433a4beb1bc",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2c6e15f8-e830-4253-8f6e-372f559bacd0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c9823a97-4183-42f9-8102-92686a5e237c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "498321d7-f785-4311-8e08-442287026440",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "3a336eb2-640a-4c8b-943d-92d90b34ced0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "1de6d396-1547-486d-b264-fbba4ba7b39e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "5c19c91e-9cf6-4fc5-836c-c9de8ae15377",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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-12-08T03:12:02.964Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "1454c4aa-b68d-4e54-b4c5-97ce626d9b0c",
"created_at": 1765163523.090599,
"updated_at": 1765163523.090599,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2da056c7-ef61-4f9d-8148-b8ad699d3d4c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7faa3278-15ff-4c29-8827-461934a98bde",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "cc91115a-8c28-4723-9b6a-f05c2afcefae",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "b5be91cf-e0fe-450a-8f56-79efea81307e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c2eaedc0-7f95-4831-9f68-31a323e41c5c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "eaad7eec-4d6f-420e-98a9-b56fe7038d52",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7e7fb683-09b7-474b-a234-59281ef33f5f",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e9979910-bf39-4444-bd29-b1519eb1c144",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "726386b0-b0c5-4738-999d-533b94015381",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e595d1e2-6a8e-4aa7-b466-eb9beb1a4858",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "55458923-9613-46ac-82e1-a1176633d01a",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "48513580-bce2-4456-8986-79ccd906cd53",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2474a79f-52c4-4e7d-90ac-446440561de2",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "f0b5dbcc-3ffa-42c9-9df0-ffbf8d386c14",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "341aea77-2714-4ab9-994d-8433a4beb1bc",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2c6e15f8-e830-4253-8f6e-372f559bacd0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c9823a97-4183-42f9-8102-92686a5e237c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "498321d7-f785-4311-8e08-442287026440",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "3a336eb2-640a-4c8b-943d-92d90b34ced0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "1de6d396-1547-486d-b264-fbba4ba7b39e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "5c19c91e-9cf6-4fc5-836c-c9de8ae15377",
"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": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b"
}Response
200Body
{
"code": "OK",
"data": {
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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": "aa88a0fa-d3e3-11f0-ad27-5e29b9842fde",
"created_at": 1765163522.060315,
"updated_at": 1765163522.060315,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"created_at": 1765163521.721124,
"updated_at": 1765163521.721124,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "c8a99a98-74e9-462b-a2e7-0f13aa1213ab",
"created_at": 1765163519.289097,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "5767bbe5-3020-47d3-afaf-81e6bf4ffc46",
"created_at": 1765163519.289097,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "895bf275-5377-44b8-838c-bacd37c7223c",
"created_at": 1765163519.289097,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "1454c4aa-b68d-4e54-b4c5-97ce626d9b0c",
"created_at": 1765163523.090599,
"updated_at": 1765163523.090599,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- rid
string(required) Example: 885e6a1f-fd6c-490a-af6b-cbceff18d5b3
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3"
}Response
200Body
{
"code": "OK",
"data": {
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2da056c7-ef61-4f9d-8148-b8ad699d3d4c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7faa3278-15ff-4c29-8827-461934a98bde",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "cc91115a-8c28-4723-9b6a-f05c2afcefae",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "b5be91cf-e0fe-450a-8f56-79efea81307e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c2eaedc0-7f95-4831-9f68-31a323e41c5c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "eaad7eec-4d6f-420e-98a9-b56fe7038d52",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7e7fb683-09b7-474b-a234-59281ef33f5f",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e9979910-bf39-4444-bd29-b1519eb1c144",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "726386b0-b0c5-4738-999d-533b94015381",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e595d1e2-6a8e-4aa7-b466-eb9beb1a4858",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "55458923-9613-46ac-82e1-a1176633d01a",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "48513580-bce2-4456-8986-79ccd906cd53",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2474a79f-52c4-4e7d-90ac-446440561de2",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "f0b5dbcc-3ffa-42c9-9df0-ffbf8d386c14",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "341aea77-2714-4ab9-994d-8433a4beb1bc",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2c6e15f8-e830-4253-8f6e-372f559bacd0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c9823a97-4183-42f9-8102-92686a5e237c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "498321d7-f785-4311-8e08-442287026440",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "3a336eb2-640a-4c8b-943d-92d90b34ced0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "1de6d396-1547-486d-b264-fbba4ba7b39e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "5c19c91e-9cf6-4fc5-836c-c9de8ae15377",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b"
}Response
200Body
{
"code": "OK",
"data": {
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"created_at": 1765163521.721124,
"updated_at": 1765163521.721124,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "c8a99a98-74e9-462b-a2e7-0f13aa1213ab",
"created_at": 1765163519.289097,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "5767bbe5-3020-47d3-afaf-81e6bf4ffc46",
"created_at": 1765163519.289097,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "895bf275-5377-44b8-838c-bacd37c7223c",
"created_at": 1765163519.289097,
"deleted_at": null,
"brand": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2da056c7-ef61-4f9d-8148-b8ad699d3d4c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7faa3278-15ff-4c29-8827-461934a98bde",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "cc91115a-8c28-4723-9b6a-f05c2afcefae",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "b5be91cf-e0fe-450a-8f56-79efea81307e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c2eaedc0-7f95-4831-9f68-31a323e41c5c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "eaad7eec-4d6f-420e-98a9-b56fe7038d52",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "7e7fb683-09b7-474b-a234-59281ef33f5f",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e9979910-bf39-4444-bd29-b1519eb1c144",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "726386b0-b0c5-4738-999d-533b94015381",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "e595d1e2-6a8e-4aa7-b466-eb9beb1a4858",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "55458923-9613-46ac-82e1-a1176633d01a",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "48513580-bce2-4456-8986-79ccd906cd53",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2474a79f-52c4-4e7d-90ac-446440561de2",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "f0b5dbcc-3ffa-42c9-9df0-ffbf8d386c14",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "341aea77-2714-4ab9-994d-8433a4beb1bc",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "2c6e15f8-e830-4253-8f6e-372f559bacd0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "c9823a97-4183-42f9-8102-92686a5e237c",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "498321d7-f785-4311-8e08-442287026440",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "3a336eb2-640a-4c8b-943d-92d90b34ced0",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "1de6d396-1547-486d-b264-fbba4ba7b39e",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "MLS",
"definition": "5c19c91e-9cf6-4fc5-836c-c9de8ae15377",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Request
Body
{
"context": [
{
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"value": "2017/12/06"
},
{
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- cid
string(required) Example: 6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_at": 1765163522.060217,
"updated_at": 1765163522.060217,
"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": "7bec2432-8bf5-4efe-8b16-d297dce05b73",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "a35351af-f60d-4205-82ca-7c4b5d7083e6",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": null,
"source": "PropertyType",
"definition": "92cd11b8-bc74-499d-a159-64de6055d2d4",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": "2025-12-08T03:11:59.289097+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2025-12-08T03:12:02.557667+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"source": "Provided",
"definition": "b00e17f3-19ab-49d8-943e-7adbd17e97e1",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "6bb9f4ad-bf87-43d7-a7ab-7e75effd1b6c",
"type": "deal_context_item",
"created_at": 1765163519.289097,
"approved_at": 1765163522.557667,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83"
}
],
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "885e6a1f-fd6c-490a-af6b-cbceff18d5b3",
"created_at": 1765163523.08626,
"updated_at": 1765163523.08626,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "1454c4aa-b68d-4e54-b4c5-97ce626d9b0c",
"created_at": 1765163523.090599,
"updated_at": 1765163523.090599,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- rid
string(required) Example: 885e6a1f-fd6c-490a-af6b-cbceff18d5b3
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "f5d05826-ff9a-463b-9ec6-e3b1d097bf7b"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"created_at": 1765163519.289097,
"updated_at": 1765163519.289097,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"order": 1,
"origin": "895bf275-5377-44b8-838c-bacd37c7223c",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- cid
string(required) Example: 3cb3dbb0-e8c9-4e6f-b434-3510f054fa83
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83"
}Response
200Body
{
"code": "OK",
"data": {
"id": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"created_at": 1765163519.289097,
"updated_at": 1765163519.289097,
"deleted_at": null,
"deactivated_at": "2025-12-08T03:12:09.292Z",
"title": "Updated Checklist 1",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"order": 3,
"origin": "895bf275-5377-44b8-838c-bacd37c7223c",
"terminated_at": "2025-12-08T03:12:09.292Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "1b8a8e74-dc61-49a6-b0a1-b354c13316a6",
"created_at": 1765163524.049743,
"updated_at": 1765163529.159312,
"room": {
"type": "room",
"id": "6ed72a84-92a0-4651-9753-f346f6c2adec",
"title": "5020 Junius Street: Test Title",
"created_at": 1765163524.03744,
"updated_at": 1765163528.780377,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "dcce7165-f376-47c4-ba0a-37ebe1dfa147",
"last_revision": "5bbac211-b758-44ef-85c2-66f8fd90edaf",
"state": "Fair",
"created_at": 1765163526.939904,
"updated_at": 1765163527.630662,
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "a37b4ccc-85b8-4b27-bb43-47252ca1e0b3",
"created_at": 1765163527.670272,
"updated_at": 1765163527.670272,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249927676&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PVVGUyWsHh3SrblRlnMAjaUqQcbGsibypfCXppOKLgHqFi4izy3PLA8VxRf4gPr4oCwD1dIz5~YmOkev0b1pb82WPmdJCgwCiXy7u74swfswArKXxHpSH5Ry5yUGcHz69xNP3S6D-Rg37J9i5PSYd6GfKgX-Ya51kLSPjKsZ5OkDpkHmoN9pPLRNupsMHYH1~FHwew1LwvRVFZBM9QfFGZJB9WzZ4V8yJCS9JeKW4dlDxJtNqDKGJYK1gu1r2o90Yu7tdfvc7pmvGSFLjiI3-qmAEUg7toku3-5O~1yJh0xOyRDXn~mhGBVI6B-J6-kNEDbGHZwmKIYM7eZr0~FW-g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "a56e5ffd-1578-4639-be15-5e89521443a6",
"created_at": 1765163528.162345,
"type": "review",
"status": "Declined",
"updated_at": 1765163528.164884
},
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/submission.pdf?hash=jFzZqXtHACj12t%2BLEmsmU%2Fhr0umbJRmLVGdcY99SYCPEWXd7StKV6ONOn38WB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2rAup6e0IATg%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: 1b8a8e74-dc61-49a6-b0a1-b354c13316a6
Response
200Body
{
"code": "OK",
"data": {
"id": "1b8a8e74-dc61-49a6-b0a1-b354c13316a6",
"created_at": 1765163524.049743,
"updated_at": 1765163526.994664,
"room": {
"type": "room",
"id": "6ed72a84-92a0-4651-9753-f346f6c2adec",
"title": "5020 Junius Street: Test Title",
"created_at": 1765163524.03744,
"updated_at": 1765163527.913026,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "dcce7165-f376-47c4-ba0a-37ebe1dfa147",
"last_revision": "5bbac211-b758-44ef-85c2-66f8fd90edaf",
"state": "Fair",
"created_at": 1765163526.939904,
"updated_at": 1765163527.630662,
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "a37b4ccc-85b8-4b27-bb43-47252ca1e0b3",
"created_at": 1765163527.670272,
"updated_at": 1765163527.670272,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249927676&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PVVGUyWsHh3SrblRlnMAjaUqQcbGsibypfCXppOKLgHqFi4izy3PLA8VxRf4gPr4oCwD1dIz5~YmOkev0b1pb82WPmdJCgwCiXy7u74swfswArKXxHpSH5Ry5yUGcHz69xNP3S6D-Rg37J9i5PSYd6GfKgX-Ya51kLSPjKsZ5OkDpkHmoN9pPLRNupsMHYH1~FHwew1LwvRVFZBM9QfFGZJB9WzZ4V8yJCS9JeKW4dlDxJtNqDKGJYK1gu1r2o90Yu7tdfvc7pmvGSFLjiI3-qmAEUg7toku3-5O~1yJh0xOyRDXn~mhGBVI6B-J6-kNEDbGHZwmKIYM7eZr0~FW-g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/submission.pdf?hash=jFzZqXtHACj12t%2BLEmsmU%2Fhr0umbJRmLVGdcY99SYCPEWXd7StKV6ONOn38WB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2qAul7f0IATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"is_deletable": true,
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "6ed72a84-92a0-4651-9753-f346f6c2adec"
}Response
200Body
{
"code": "OK",
"data": {
"id": "1b8a8e74-dc61-49a6-b0a1-b354c13316a6",
"created_at": 1765163524.049743,
"updated_at": 1765163524.049743,
"room": {
"type": "room",
"id": "6ed72a84-92a0-4651-9753-f346f6c2adec",
"title": "5020 Junius Street: Test Title",
"created_at": 1765163524.03744,
"updated_at": 1765163524.154245,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/submission.pdf?hash=jFzZqXtHACj12t%2BLEmsmU%2Fhr0umbJRmLVGdcY99SYCPEWXd7StKV6ONOn38WB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2mAut6e0IATg%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: 1b8a8e74-dc61-49a6-b0a1-b354c13316a6
Request
Body
{
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"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": "dcce7165-f376-47c4-ba0a-37ebe1dfa147",
"last_revision": "fd90bf2e-8490-4473-be72-490e3a081b88",
"state": "Fair",
"created_at": 1765163526.939904,
"updated_at": 1765163527.236129,
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "e94979c0-f546-4637-bdb4-9dd51b3e3e6f",
"created_at": 1765163527.265773,
"updated_at": 1765163527.265773,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/ad9f71b0-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/ad9f71b0-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249927278&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=TCJGeo00s3~9M26aDa~pz2MeEBGb5YRy8Bae8lNnypT2z2sBc1TzNwhJto10HUtcv29vzZpaKP6sZGr8ShJQ9bKGqoVpolt3yVEA-q~b2UKB59UvLYFPrUlEVTxMn-yJjIF8cQoijtS3MGUlQTfSlXoNtGJD1d3oUqNYQLgaVF0a0DIROD5uCfp3QPlCuiyk4E2yz9qlynMU4Z4AiuPmEpOXGvo-hkmv~TaJTrbMnY8nOYUs6H0~f0MiVQMdOPHKzD-0rg9xRXIa-lUmZa0h~ts9HcFwLQV9HFLVOr9kIDOGWSucMnNmaA1w9bF69abAew-rlLzIyuRUleaotvPWzQ__",
"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: 1b8a8e74-dc61-49a6-b0a1-b354c13316a6- revision
string(required) Example: fd90bf2e-8490-4473-be72-490e3a081b88
Response
200Body
{
"code": "OK",
"data": {
"id": "fd90bf2e-8490-4473-be72-490e3a081b88",
"submission": "dcce7165-f376-47c4-ba0a-37ebe1dfa147",
"created_at": 1765163526.939904,
"updated_at": 1765163527.236129,
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "e94979c0-f546-4637-bdb4-9dd51b3e3e6f"
}
}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: 1b8a8e74-dc61-49a6-b0a1-b354c13316a6
Request
Body
{
"status": "Declined",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "1b8a8e74-dc61-49a6-b0a1-b354c13316a6",
"created_at": 1765163524.049743,
"updated_at": 1765163528.176804,
"room": {
"type": "room",
"id": "6ed72a84-92a0-4651-9753-f346f6c2adec",
"title": "5020 Junius Street: Test Title",
"created_at": 1765163524.03744,
"updated_at": 1765163528.220539,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "dcce7165-f376-47c4-ba0a-37ebe1dfa147",
"last_revision": "5bbac211-b758-44ef-85c2-66f8fd90edaf",
"state": "Fair",
"created_at": 1765163526.939904,
"updated_at": 1765163527.630662,
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "a37b4ccc-85b8-4b27-bb43-47252ca1e0b3",
"created_at": 1765163527.670272,
"updated_at": 1765163527.670272,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249927676&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PVVGUyWsHh3SrblRlnMAjaUqQcbGsibypfCXppOKLgHqFi4izy3PLA8VxRf4gPr4oCwD1dIz5~YmOkev0b1pb82WPmdJCgwCiXy7u74swfswArKXxHpSH5Ry5yUGcHz69xNP3S6D-Rg37J9i5PSYd6GfKgX-Ya51kLSPjKsZ5OkDpkHmoN9pPLRNupsMHYH1~FHwew1LwvRVFZBM9QfFGZJB9WzZ4V8yJCS9JeKW4dlDxJtNqDKGJYK1gu1r2o90Yu7tdfvc7pmvGSFLjiI3-qmAEUg7toku3-5O~1yJh0xOyRDXn~mhGBVI6B-J6-kNEDbGHZwmKIYM7eZr0~FW-g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "a56e5ffd-1578-4639-be15-5e89521443a6",
"created_at": 1765163528.162345,
"type": "review",
"status": "Declined",
"updated_at": 1765163528.164884
},
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/submission.pdf?hash=jFzZqXtHACj12t%2BLEmsmU%2Fhr0umbJRmLVGdcY99SYCPEWXd7StKV6ONOn38WB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2qAup0d0IATg%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: 1b8a8e74-dc61-49a6-b0a1-b354c13316a6
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "1b8a8e74-dc61-49a6-b0a1-b354c13316a6",
"created_at": 1765163524.049743,
"updated_at": 1765163528.84145,
"room": {
"type": "room",
"id": "6ed72a84-92a0-4651-9753-f346f6c2adec",
"title": "5020 Junius Street: Test Title",
"created_at": 1765163524.03744,
"updated_at": 1765163528.780377,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "dcce7165-f376-47c4-ba0a-37ebe1dfa147",
"last_revision": "5bbac211-b758-44ef-85c2-66f8fd90edaf",
"state": "Fair",
"created_at": 1765163526.939904,
"updated_at": 1765163527.630662,
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "a37b4ccc-85b8-4b27-bb43-47252ca1e0b3",
"created_at": 1765163527.670272,
"updated_at": 1765163527.670272,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/addca1c0-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249927676&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PVVGUyWsHh3SrblRlnMAjaUqQcbGsibypfCXppOKLgHqFi4izy3PLA8VxRf4gPr4oCwD1dIz5~YmOkev0b1pb82WPmdJCgwCiXy7u74swfswArKXxHpSH5Ry5yUGcHz69xNP3S6D-Rg37J9i5PSYd6GfKgX-Ya51kLSPjKsZ5OkDpkHmoN9pPLRNupsMHYH1~FHwew1LwvRVFZBM9QfFGZJB9WzZ4V8yJCS9JeKW4dlDxJtNqDKGJYK1gu1r2o90Yu7tdfvc7pmvGSFLjiI3-qmAEUg7toku3-5O~1yJh0xOyRDXn~mhGBVI6B-J6-kNEDbGHZwmKIYM7eZr0~FW-g__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "a56e5ffd-1578-4639-be15-5e89521443a6",
"created_at": 1765163528.162345,
"type": "review",
"status": "Declined",
"updated_at": 1765163528.164884
},
"form": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2025-12-08T03:12:08.841Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/submission.pdf?hash=jFzZqXtHACj12t%2BLEmsmU%2Fhr0umbJRmLVGdcY99SYCPEWXd7StKV6ONOn38WB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2qAuBweUIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: 3abb278b-c924-4656-b94e-93de9251b010
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "3abb278b-c924-4656-b94e-93de9251b010",
"created_at": 1765163524.368273,
"updated_at": 1765163525.137766,
"room": {
"type": "room",
"id": "98dc8176-1710-4627-ae9d-80b45e5e851b",
"title": "5020 Junius Street: Another Task",
"created_at": 1765163524.351131,
"updated_at": 1765163524.488617,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/3abb278b-c924-4656-b94e-93de9251b010/submission.pdf?hash=jFzZqXtHACj12NzREWF0XK5r1bOfIBmLWzNcY99bNXfEAncqG4iW7uEdmS8QB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2nAutyfUIATg%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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Request
Body
[
{
"id": "1b8a8e74-dc61-49a6-b0a1-b354c13316a6",
"title": "Bulk Test Title"
},
{
"id": "3abb278b-c924-4656-b94e-93de9251b010",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "1b8a8e74-dc61-49a6-b0a1-b354c13316a6",
"created_at": 1765163524.049743,
"updated_at": 1765163525.309049,
"room": {
"type": "room",
"id": "6ed72a84-92a0-4651-9753-f346f6c2adec",
"title": "5020 Junius Street: Test Title",
"created_at": 1765163524.03744,
"updated_at": 1765163524.935952,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"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": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/submission.pdf?hash=jFzZqXtHACj12t%2BLEmsmU%2Fhr0umbJRmLVGdcY99SYCPEWXd7StKV6ONOn38WB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2nAuxxfkIATg%3D%3D"
},
{
"id": "3abb278b-c924-4656-b94e-93de9251b010",
"created_at": 1765163524.368273,
"updated_at": 1765163525.436665,
"room": {
"type": "room",
"id": "98dc8176-1710-4627-ae9d-80b45e5e851b",
"title": "5020 Junius Street: Another Task",
"created_at": 1765163524.351131,
"updated_at": 1765163525.37254,
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"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": "5c632ef0-3e64-4686-979d-4e9d6050bb8c",
"checklist": "3cb3dbb0-e8c9-4e6f-b434-3510f054fa83",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2025-12-08T03:12:05.436Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/3abb278b-c924-4656-b94e-93de9251b010/submission.pdf?hash=jFzZqXtHACj12NzREWF0XK5r1bOfIBmLWzNcY99bNXfEAncqG4iW7uEdmS8QB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZxWqR%2FaAyoJGzNu8k3pX2nAuxxfkIATg%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: 1b8a8e74-dc61-49a6-b0a1-b354c13316a6
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "e94979c0-f546-4637-bdb4-9dd51b3e3e6f"
}Response
200Body
{
"code": "OK",
"data": {
"id": "577c7458-80be-41ce-ab6e-b5685640aadb",
"reference": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"reference_type": "User",
"created_at": 1765163527.889516,
"updated_at": 1765163527.889516,
"deleted_at": null,
"object": {
"id": "e94979c0-f546-4637-bdb4-9dd51b3e3e6f",
"created_at": 1765163527.265773,
"updated_at": 1765163527.265773,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/ad9f71b0-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1b8a8e74-dc61-49a6-b0a1-b354c13316a6/ad9f71b0-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249927278&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=TCJGeo00s3~9M26aDa~pz2MeEBGb5YRy8Bae8lNnypT2z2sBc1TzNwhJto10HUtcv29vzZpaKP6sZGr8ShJQ9bKGqoVpolt3yVEA-q~b2UKB59UvLYFPrUlEVTxMn-yJjIF8cQoijtS3MGUlQTfSlXoNtGJD1d3oUqNYQLgaVF0a0DIROD5uCfp3QPlCuiyk4E2yz9qlynMU4Z4AiuPmEpOXGvo-hkmv~TaJTrbMnY8nOYUs6H0~f0MiVQMdOPHKzD-0rg9xRXIa-lUmZa0h~ts9HcFwLQV9HFLVOr9kIDOGWSucMnNmaA1w9bF69abAew-rlLzIyuRUleaotvPWzQ__",
"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: 1b8a8e74-dc61-49a6-b0a1-b354c13316a6
Request
Body
{
"comment": "Comment",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "6ed72a84-92a0-4651-9753-f346f6c2adec"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "b6cf41bf-35be-4d66-be0b-267221c2564b",
"id": "b6cf41bf-35be-4d66-be0b-267221c2564b",
"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": 1765163519.289097,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "9:11 PM - Sunday Dec 07, 2025",
"push_allowed": true,
"agents": [
{
"id": "dd01ac14-22a8-4339-977c-5e4c07a72255",
"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": 1765163519.61061,
"deleted_at": null,
"created_at": 1765163519.61061,
"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": "bf213a9f-2514-4ee4-ab1d-32b834651e23",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"created_at": 1765163529.489102,
"updated_at": 1765163529.489102,
"room": "6ed72a84-92a0-4651-9753-f346f6c2adec",
"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: 3abb278b-c924-4656-b94e-93de9251b010
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Response
200Body
{
"code": "OK",
"data": {
"id": "ea48f289-eb12-4dd6-a54b-fd69d833b5e4",
"created_at": 1765163530.230318,
"updated_at": 1765163530.230318,
"deleted_at": null,
"gallery": "aa88a0fa-d3e3-11f0-ad27-5e29b9842fde",
"name": null,
"order": 0,
"file": {
"id": "44aec231-cd41-4099-9a1c-0029a2c3ba6c",
"created_at": 1765163530.20632,
"updated_at": 1765163530.20632,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af62f3a0-d3e3-11f0-a2d4-1bcac3894d4e.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af62f3a0-d3e3-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af62f3a0-d3e3-11f0-a2d4-1bcac3894d4e.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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- iid
string(required) Example: ea48f289-eb12-4dd6-a54b-fd69d833b5e4
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "44aec231-cd41-4099-9a1c-0029a2c3ba6c"
}Response
200Body
{
"code": "OK",
"data": {
"id": "ea48f289-eb12-4dd6-a54b-fd69d833b5e4",
"created_at": 1765163530.230318,
"updated_at": 1765163519.289097,
"deleted_at": null,
"gallery": "aa88a0fa-d3e3-11f0-ad27-5e29b9842fde",
"name": "Updated Name",
"order": 2,
"file": {
"id": "44aec231-cd41-4099-9a1c-0029a2c3ba6c",
"created_at": 1765163530.20632,
"updated_at": 1765163530.20632,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af62f3a0-d3e3-11f0-a2d4-1bcac3894d4e.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af62f3a0-d3e3-11f0-a2d4-1bcac3894d4e.png",
"preview_url": "https://test.cloudfront.net/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af62f3a0-d3e3-11f0-a2d4-1bcac3894d4e.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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f- iid
string(required) Example: ea48f289-eb12-4dd6-a54b-fd69d833b5e4
Response
200Body
{
"code": "OK",
"data": {
"id": "ea48f289-eb12-4dd6-a54b-fd69d833b5e4",
"created_at": 1765163530.230318,
"updated_at": 1765163519.289097,
"deleted_at": null,
"gallery": "aa88a0fa-d3e3-11f0-ad27-5e29b9842fde",
"name": "Updated Name",
"order": 2,
"file": {
"id": "7054da1c-e321-49d8-80bb-03c4fc29bbe5",
"created_at": 1765163530.318344,
"updated_at": 1765163530.318344,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af740aa0-d3e3-11f0-a2d4-1bcac3894d4e.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af740aa0-d3e3-11f0-a2d4-1bcac3894d4e.png?Expires=1765249930330&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ABRqGqy10mUWztZVxUT6Tr3b7lrYZ3cDU09xspzdQ6B6YWRmOQErqwQyVgBIEGBPF32PHAKSTmqoM0NoLhfEDEtZje1AItfdrqAFW6Lm88Sj9-orutCfLH2RESNfySfWpM5RJiK-cv3olM0FDKJAYAxCW6ipw0KlGAjxAPl354~rj61ZvLL1sO2NpK~YkgwEn5KMtRNzmAv0dEDVRzGF4mf7BIoh13IIrdfgMQvZXDrWr--xYX0owvQn6OvJVc~GXpv7wfhqP1nisrXo7fq~PsOeBtf50t~KVQNByGee6pfiOQJaOBFJTosPka0JIr7RCruMbpWrhpopTqJ2jZmCiQ__",
"preview_url": "https://private-cdn.irish.rechat.com/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af740aa0-d3e3-11f0-a2d4-1bcac3894d4e.png?Expires=1765249930330&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ABRqGqy10mUWztZVxUT6Tr3b7lrYZ3cDU09xspzdQ6B6YWRmOQErqwQyVgBIEGBPF32PHAKSTmqoM0NoLhfEDEtZje1AItfdrqAFW6Lm88Sj9-orutCfLH2RESNfySfWpM5RJiK-cv3olM0FDKJAYAxCW6ipw0KlGAjxAPl354~rj61ZvLL1sO2NpK~YkgwEn5KMtRNzmAv0dEDVRzGF4mf7BIoh13IIrdfgMQvZXDrWr--xYX0owvQn6OvJVc~GXpv7wfhqP1nisrXo7fq~PsOeBtf50t~KVQNByGee6pfiOQJaOBFJTosPka0JIr7RCruMbpWrhpopTqJ2jZmCiQ__",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Request
Body
[
{
"id": "ea48f289-eb12-4dd6-a54b-fd69d833b5e4",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "ea48f289-eb12-4dd6-a54b-fd69d833b5e4",
"created_at": 1765163530.230318,
"updated_at": 1765163519.289097,
"deleted_at": 1765163519.289097,
"gallery": "aa88a0fa-d3e3-11f0-ad27-5e29b9842fde",
"name": "Updated Name",
"order": 3,
"file": {
"id": "7054da1c-e321-49d8-80bb-03c4fc29bbe5",
"created_at": 1765163530.318344,
"updated_at": 1765163530.318344,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af740aa0-d3e3-11f0-a2d4-1bcac3894d4e.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af740aa0-d3e3-11f0-a2d4-1bcac3894d4e.png?Expires=1765249930330&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ABRqGqy10mUWztZVxUT6Tr3b7lrYZ3cDU09xspzdQ6B6YWRmOQErqwQyVgBIEGBPF32PHAKSTmqoM0NoLhfEDEtZje1AItfdrqAFW6Lm88Sj9-orutCfLH2RESNfySfWpM5RJiK-cv3olM0FDKJAYAxCW6ipw0KlGAjxAPl354~rj61ZvLL1sO2NpK~YkgwEn5KMtRNzmAv0dEDVRzGF4mf7BIoh13IIrdfgMQvZXDrWr--xYX0owvQn6OvJVc~GXpv7wfhqP1nisrXo7fq~PsOeBtf50t~KVQNByGee6pfiOQJaOBFJTosPka0JIr7RCruMbpWrhpopTqJ2jZmCiQ__",
"preview_url": "https://private-cdn.irish.rechat.com/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/af740aa0-d3e3-11f0-a2d4-1bcac3894d4e.png?Expires=1765249930330&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ABRqGqy10mUWztZVxUT6Tr3b7lrYZ3cDU09xspzdQ6B6YWRmOQErqwQyVgBIEGBPF32PHAKSTmqoM0NoLhfEDEtZje1AItfdrqAFW6Lm88Sj9-orutCfLH2RESNfySfWpM5RJiK-cv3olM0FDKJAYAxCW6ipw0KlGAjxAPl354~rj61ZvLL1sO2NpK~YkgwEn5KMtRNzmAv0dEDVRzGF4mf7BIoh13IIrdfgMQvZXDrWr--xYX0owvQn6OvJVc~GXpv7wfhqP1nisrXo7fq~PsOeBtf50t~KVQNByGee6pfiOQJaOBFJTosPka0JIr7RCruMbpWrhpopTqJ2jZmCiQ__",
"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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Request
Body
{
"items": [
"ea48f289-eb12-4dd6-a54b-fd69d833b5e4"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/aa88a0fa-d3e3-11f0-ad27-5e29b9842fde.zip?hash=jFzKqWRAR2CuyYeREjJ7XK120OuAcAfaXitbf9tSLHONCXNjS9SW4rJGkSoSQyDgkxDSPuwS29FDCKVDtEbmgEfBX7kWJ5cSkh3puldnfF9wg5WxjiM9LFcybr1WdrfQEGPBAzRU3EZ2R6d4aA2iXWzG1cg2pXygFuhzYCwaB1KFCeqzv8aof7YNuyTr1HDOgDcXATgZtBrY1X0lt7sjqDMn5%2FchRl8Krz7MX0Rp%2BS2bE7M%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: 80d7ed6e-0b35-45b7-bcfb-f67e3448c29f
Response
200Body
{
"code": "OK",
"data": {
"id": "8abbbd8f-a96e-4ca0-9904-320bfcdf8f40",
"created_at": 1765163530.798772,
"updated_at": 1765163530.798773,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/afbc1020-d3e3-11f0-a2d4-1bcac3894d4e.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/80d7ed6e-0b35-45b7-bcfb-f67e3448c29f/afbc1020-d3e3-11f0-a2d4-1bcac3894d4e.zip?Expires=1765249930803&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=EW-lOzBDhSQCr2K3LlUypGyLCyf7BW9oeFKNmuACwszUyUGAiOt1XPgZeMiTNC1Deaq~SvvATPlT1gIEzmlhzFhwIUkMiC2NfAXC6LOmkzLDaGO017UV1HuX~qWjqXnjamn1gh1-bUWc1EzWzAlX-bIYVEzA6hAiuNz5JfRtn2U0R7LiX18MvKup0scqoIHO0FslnADptnw9OQQD2Xk9Q1PrCnrTHTKTzonLpzULB9WZSB9HC4IKNOyE3u2ISH40pd0~FI3Cqc6jmL3i7lBcA~cKuv5L4NifxkQAvTLvX9iBhrlaLzzJDur0xIKldlQAZxo0HUbjSFiKpWShFTVMvg__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}