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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Response
200Body
{
"code": "OK",
"data": {
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-01-23T01:41:52.054Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "2f623422-5ab0-4bbb-a141-d5bd57c837bd",
"created_at": 1769132512.130284,
"updated_at": 1769132512.130284,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f24db9ef-9c46-4d00-ac09-5ef19e50014d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "2d58bbd6-37f6-4a74-ae4f-fec3b9904698",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c981fed8-6946-447f-8b00-2546b2678b0e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d4706ccb-2993-4608-9559-17a84885bcb4",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "eb38c1fa-3584-47fe-a99c-cefe39f41a1f",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f6f32711-a80c-4dc6-be06-9b39101fdaa3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c6f97b6c-607d-44d6-b396-318943bb61b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "8960bc5e-388d-4baf-9d1d-5afbd69a3317",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "72bd3af9-e70f-4282-b2a5-10188310099e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7429f8f3-213b-4ee8-89b0-dc2e38da9ca7",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d69d4345-7f88-40fb-8ba7-d0440f5397d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c015a5c7-4092-4ac3-859c-37d5229d43d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "a37be325-f1e2-43f8-9783-6a4ee2673753",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "b29b64a9-e72d-4ec0-981f-06a7d94b6a2e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7974e3ae-132e-47de-8b4a-03cd50edf77e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "02db6be1-38fe-4831-ac3c-22c25cbb82b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "996ee526-29bb-4399-a10d-b2b9619bf23d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1e56807a-a423-45a2-9ddb-e68208697b90",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1dc4e9ac-5815-43f2-914b-9fdc22bc4d4b",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "fca6bc9a-bc45-4f83-8335-c9ba932d1aad",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f0ca43f7-5634-4705-8749-18c670787242",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-01-23T01:41:52.054Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "2f623422-5ab0-4bbb-a141-d5bd57c837bd",
"created_at": 1769132512.130284,
"updated_at": 1769132512.130284,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f24db9ef-9c46-4d00-ac09-5ef19e50014d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "2d58bbd6-37f6-4a74-ae4f-fec3b9904698",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c981fed8-6946-447f-8b00-2546b2678b0e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d4706ccb-2993-4608-9559-17a84885bcb4",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "eb38c1fa-3584-47fe-a99c-cefe39f41a1f",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f6f32711-a80c-4dc6-be06-9b39101fdaa3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c6f97b6c-607d-44d6-b396-318943bb61b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "8960bc5e-388d-4baf-9d1d-5afbd69a3317",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "72bd3af9-e70f-4282-b2a5-10188310099e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7429f8f3-213b-4ee8-89b0-dc2e38da9ca7",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d69d4345-7f88-40fb-8ba7-d0440f5397d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c015a5c7-4092-4ac3-859c-37d5229d43d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "a37be325-f1e2-43f8-9783-6a4ee2673753",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "b29b64a9-e72d-4ec0-981f-06a7d94b6a2e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7974e3ae-132e-47de-8b4a-03cd50edf77e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "02db6be1-38fe-4831-ac3c-22c25cbb82b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "996ee526-29bb-4399-a10d-b2b9619bf23d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1e56807a-a423-45a2-9ddb-e68208697b90",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1dc4e9ac-5815-43f2-914b-9fdc22bc4d4b",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "fca6bc9a-bc45-4f83-8335-c9ba932d1aad",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f0ca43f7-5634-4705-8749-18c670787242",
"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: 7088dbae-dc66-417c-bbad-23eb419d7588
Response
200Body
{
"code": "OK",
"data": [
{
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-01-23T01:41:52.054Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "2f623422-5ab0-4bbb-a141-d5bd57c837bd",
"created_at": 1769132512.130284,
"updated_at": 1769132512.130284,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f24db9ef-9c46-4d00-ac09-5ef19e50014d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "2d58bbd6-37f6-4a74-ae4f-fec3b9904698",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c981fed8-6946-447f-8b00-2546b2678b0e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d4706ccb-2993-4608-9559-17a84885bcb4",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "eb38c1fa-3584-47fe-a99c-cefe39f41a1f",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f6f32711-a80c-4dc6-be06-9b39101fdaa3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c6f97b6c-607d-44d6-b396-318943bb61b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "8960bc5e-388d-4baf-9d1d-5afbd69a3317",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "72bd3af9-e70f-4282-b2a5-10188310099e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7429f8f3-213b-4ee8-89b0-dc2e38da9ca7",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d69d4345-7f88-40fb-8ba7-d0440f5397d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c015a5c7-4092-4ac3-859c-37d5229d43d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "a37be325-f1e2-43f8-9783-6a4ee2673753",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "b29b64a9-e72d-4ec0-981f-06a7d94b6a2e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7974e3ae-132e-47de-8b4a-03cd50edf77e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "02db6be1-38fe-4831-ac3c-22c25cbb82b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "996ee526-29bb-4399-a10d-b2b9619bf23d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1e56807a-a423-45a2-9ddb-e68208697b90",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1dc4e9ac-5815-43f2-914b-9fdc22bc4d4b",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "fca6bc9a-bc45-4f83-8335-c9ba932d1aad",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f0ca43f7-5634-4705-8749-18c670787242",
"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: 7088dbae-dc66-417c-bbad-23eb419d7588
Response
200Body
{
"code": "OK",
"data": [
{
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-01-23T01:41:52.054Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1769132515.926726,
"is_draft": false,
"roles": [
{
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "2f623422-5ab0-4bbb-a141-d5bd57c837bd",
"created_at": 1769132512.130284,
"updated_at": 1769132512.130284,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f24db9ef-9c46-4d00-ac09-5ef19e50014d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "2d58bbd6-37f6-4a74-ae4f-fec3b9904698",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c981fed8-6946-447f-8b00-2546b2678b0e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d4706ccb-2993-4608-9559-17a84885bcb4",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "eb38c1fa-3584-47fe-a99c-cefe39f41a1f",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f6f32711-a80c-4dc6-be06-9b39101fdaa3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c6f97b6c-607d-44d6-b396-318943bb61b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "8960bc5e-388d-4baf-9d1d-5afbd69a3317",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "72bd3af9-e70f-4282-b2a5-10188310099e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7429f8f3-213b-4ee8-89b0-dc2e38da9ca7",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d69d4345-7f88-40fb-8ba7-d0440f5397d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c015a5c7-4092-4ac3-859c-37d5229d43d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "a37be325-f1e2-43f8-9783-6a4ee2673753",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "b29b64a9-e72d-4ec0-981f-06a7d94b6a2e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7974e3ae-132e-47de-8b4a-03cd50edf77e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "02db6be1-38fe-4831-ac3c-22c25cbb82b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "996ee526-29bb-4399-a10d-b2b9619bf23d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1e56807a-a423-45a2-9ddb-e68208697b90",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1dc4e9ac-5815-43f2-914b-9fdc22bc4d4b",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "fca6bc9a-bc45-4f83-8335-c9ba932d1aad",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f0ca43f7-5634-4705-8749-18c670787242",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-01-23T01:41:52.054Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "2f623422-5ab0-4bbb-a141-d5bd57c837bd",
"created_at": 1769132512.130284,
"updated_at": 1769132512.130284,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f24db9ef-9c46-4d00-ac09-5ef19e50014d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "2d58bbd6-37f6-4a74-ae4f-fec3b9904698",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c981fed8-6946-447f-8b00-2546b2678b0e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d4706ccb-2993-4608-9559-17a84885bcb4",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "eb38c1fa-3584-47fe-a99c-cefe39f41a1f",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f6f32711-a80c-4dc6-be06-9b39101fdaa3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c6f97b6c-607d-44d6-b396-318943bb61b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "8960bc5e-388d-4baf-9d1d-5afbd69a3317",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "72bd3af9-e70f-4282-b2a5-10188310099e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7429f8f3-213b-4ee8-89b0-dc2e38da9ca7",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d69d4345-7f88-40fb-8ba7-d0440f5397d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c015a5c7-4092-4ac3-859c-37d5229d43d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "a37be325-f1e2-43f8-9783-6a4ee2673753",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "b29b64a9-e72d-4ec0-981f-06a7d94b6a2e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7974e3ae-132e-47de-8b4a-03cd50edf77e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "02db6be1-38fe-4831-ac3c-22c25cbb82b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "996ee526-29bb-4399-a10d-b2b9619bf23d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1e56807a-a423-45a2-9ddb-e68208697b90",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1dc4e9ac-5815-43f2-914b-9fdc22bc4d4b",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "fca6bc9a-bc45-4f83-8335-c9ba932d1aad",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f0ca43f7-5634-4705-8749-18c670787242",
"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": "6afd8950-2c79-433a-b362-6f47599993d1"
}Response
200Body
{
"code": "OK",
"data": {
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"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": "b0aba5b2-f7fc-11f0-952b-d6c27ed4418a",
"created_at": 1769132511.634374,
"updated_at": 1769132511.634374,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "6afd8950-2c79-433a-b362-6f47599993d1",
"created_at": 1769132511.422406,
"updated_at": 1769132511.422406,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "53b0ceeb-7176-4124-afe3-9a384991a7a0",
"created_at": 1769132510.560495,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "86ae0794-5859-43d1-88cf-7666e34cf69e",
"created_at": 1769132510.560495,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "c4335be8-e541-4ff0-99f4-0b939dbcff4d",
"created_at": 1769132510.560495,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "2f623422-5ab0-4bbb-a141-d5bd57c837bd",
"created_at": 1769132512.130284,
"updated_at": 1769132512.130284,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- rid
string(required) Example: 5400a238-e721-43d7-b89d-aa71f5802819
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "5400a238-e721-43d7-b89d-aa71f5802819"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f24db9ef-9c46-4d00-ac09-5ef19e50014d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "2d58bbd6-37f6-4a74-ae4f-fec3b9904698",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c981fed8-6946-447f-8b00-2546b2678b0e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d4706ccb-2993-4608-9559-17a84885bcb4",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "eb38c1fa-3584-47fe-a99c-cefe39f41a1f",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f6f32711-a80c-4dc6-be06-9b39101fdaa3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c6f97b6c-607d-44d6-b396-318943bb61b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "8960bc5e-388d-4baf-9d1d-5afbd69a3317",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "72bd3af9-e70f-4282-b2a5-10188310099e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7429f8f3-213b-4ee8-89b0-dc2e38da9ca7",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d69d4345-7f88-40fb-8ba7-d0440f5397d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c015a5c7-4092-4ac3-859c-37d5229d43d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "a37be325-f1e2-43f8-9783-6a4ee2673753",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "b29b64a9-e72d-4ec0-981f-06a7d94b6a2e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7974e3ae-132e-47de-8b4a-03cd50edf77e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "02db6be1-38fe-4831-ac3c-22c25cbb82b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "996ee526-29bb-4399-a10d-b2b9619bf23d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1e56807a-a423-45a2-9ddb-e68208697b90",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1dc4e9ac-5815-43f2-914b-9fdc22bc4d4b",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "fca6bc9a-bc45-4f83-8335-c9ba932d1aad",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f0ca43f7-5634-4705-8749-18c670787242",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1"
}Response
200Body
{
"code": "OK",
"data": {
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"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": "6afd8950-2c79-433a-b362-6f47599993d1",
"created_at": 1769132511.422406,
"updated_at": 1769132511.422406,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "53b0ceeb-7176-4124-afe3-9a384991a7a0",
"created_at": 1769132510.560495,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "86ae0794-5859-43d1-88cf-7666e34cf69e",
"created_at": 1769132510.560495,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "c4335be8-e541-4ff0-99f4-0b939dbcff4d",
"created_at": 1769132510.560495,
"deleted_at": null,
"brand": "7088dbae-dc66-417c-bbad-23eb419d7588",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f24db9ef-9c46-4d00-ac09-5ef19e50014d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "2d58bbd6-37f6-4a74-ae4f-fec3b9904698",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c981fed8-6946-447f-8b00-2546b2678b0e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d4706ccb-2993-4608-9559-17a84885bcb4",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "eb38c1fa-3584-47fe-a99c-cefe39f41a1f",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f6f32711-a80c-4dc6-be06-9b39101fdaa3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c6f97b6c-607d-44d6-b396-318943bb61b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "8960bc5e-388d-4baf-9d1d-5afbd69a3317",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "72bd3af9-e70f-4282-b2a5-10188310099e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7429f8f3-213b-4ee8-89b0-dc2e38da9ca7",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "d69d4345-7f88-40fb-8ba7-d0440f5397d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "c015a5c7-4092-4ac3-859c-37d5229d43d3",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "a37be325-f1e2-43f8-9783-6a4ee2673753",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "b29b64a9-e72d-4ec0-981f-06a7d94b6a2e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "7974e3ae-132e-47de-8b4a-03cd50edf77e",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "02db6be1-38fe-4831-ac3c-22c25cbb82b9",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "996ee526-29bb-4399-a10d-b2b9619bf23d",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1e56807a-a423-45a2-9ddb-e68208697b90",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "1dc4e9ac-5815-43f2-914b-9fdc22bc4d4b",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "fca6bc9a-bc45-4f83-8335-c9ba932d1aad",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "MLS",
"definition": "f0ca43f7-5634-4705-8749-18c670787242",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Request
Body
{
"context": [
{
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"value": "2017/12/06"
},
{
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"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": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- cid
string(required) Example: cae2577d-6c9a-43f2-93b9-36cbab9163cd
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_at": 1769132511.634311,
"updated_at": 1769132511.634311,
"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": "3da65c1f-9ba0-40af-9873-fc1c8978352a",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "e990470a-a942-4a44-9192-a16dd68ed968",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": null,
"source": "PropertyType",
"definition": "014c58f4-4e3b-4ed5-a6d5-42c0fa59f54f",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": "2026-01-23T01:41:50.560495+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-01-23T01:41:51.847659+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"source": "Provided",
"definition": "570c2d91-3d58-474e-8d63-52f3f67f7ffe",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "cae2577d-6c9a-43f2-93b9-36cbab9163cd",
"type": "deal_context_item",
"created_at": 1769132510.560495,
"approved_at": 1769132511.847659,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd"
}
],
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "5400a238-e721-43d7-b89d-aa71f5802819",
"created_at": 1769132512.128311,
"updated_at": 1769132512.128311,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "2f623422-5ab0-4bbb-a141-d5bd57c837bd",
"created_at": 1769132512.130284,
"updated_at": 1769132512.130284,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- rid
string(required) Example: 5400a238-e721-43d7-b89d-aa71f5802819
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "6afd8950-2c79-433a-b362-6f47599993d1"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"created_at": 1769132510.560495,
"updated_at": 1769132510.560495,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"order": 1,
"origin": "c4335be8-e541-4ff0-99f4-0b939dbcff4d",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- cid
string(required) Example: 7322ba26-82f9-4c55-8428-77c0c99377bd
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "7322ba26-82f9-4c55-8428-77c0c99377bd"
}Response
200Body
{
"code": "OK",
"data": {
"id": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"created_at": 1769132510.560495,
"updated_at": 1769132510.560495,
"deleted_at": null,
"deactivated_at": "2026-01-23T01:41:56.252Z",
"title": "Updated Checklist 1",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"order": 3,
"origin": "c4335be8-e541-4ff0-99f4-0b939dbcff4d",
"terminated_at": "2026-01-23T01:41:56.252Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "1ecfcbc9-1028-48c8-b21d-76fd85e0c558",
"created_at": 1769132512.78493,
"updated_at": 1769132516.14432,
"room": {
"type": "room",
"id": "cee05dd5-7a8a-4d83-8802-3172e5bada2c",
"title": "5020 Junius Street: Test Title",
"created_at": 1769132512.773718,
"updated_at": 1769132515.889106,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "0dc62b15-a5ae-4a4f-a0f8-278507ff9d23",
"last_revision": "fe0a1994-daca-4c5a-98cb-ff69824c7d3d",
"state": "Fair",
"created_at": 1769132514.694757,
"updated_at": 1769132515.116709,
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "bbd281ba-eaa3-4dce-a3bd-6b9d501b07c8",
"created_at": 1769132515.134722,
"updated_at": 1769132515.134722,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf?Expires=1769218915137&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NPe0qgLoz2kZJMehjryxyF83~CIhbtf0V0Ls~hIZuLThc8yBccKpAMtAFBoSpeg9WoypAaE455HqUVyyiEgg7QQFvDJE3LvYuDZGzjj4trJljn84g2ZvZ2kKMarki-~KRzThnd5fcSNwUGb3AqMMRGBB0a9mzRK3IwYZV1EWmTAIgUvAB7-VST0jr6AreESjUD2qbHOx57F-OQyd2cqFekHsk0Tn0OCmlBHIFbuIXVIT-a9gFLobcu~OoaGeIau-G9V-IBrLHjI~D29r3EI9kbClnkrwxTHM~dWaju3SyvWjzNlelxmFO5rSZuDnOdq2bjeNNHV5UqT3tgG6g4aVtg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "97a68f0d-34a7-4997-a151-340d7c290b31",
"created_at": 1769132515.44616,
"type": "review",
"status": "Declined",
"updated_at": 1769132515.448248
},
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/submission.pdf?hash=jFzZqXtHACj12tjQFTAhB%2FVrh7qfLBmLVWVSY99QMHbEDHIoGomRvuAcnCsYB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXikAupyekIATg%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: 1ecfcbc9-1028-48c8-b21d-76fd85e0c558
Response
200Body
{
"code": "OK",
"data": {
"id": "1ecfcbc9-1028-48c8-b21d-76fd85e0c558",
"created_at": 1769132512.78493,
"updated_at": 1769132514.729362,
"room": {
"type": "room",
"id": "cee05dd5-7a8a-4d83-8802-3172e5bada2c",
"title": "5020 Junius Street: Test Title",
"created_at": 1769132512.773718,
"updated_at": 1769132515.279122,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "0dc62b15-a5ae-4a4f-a0f8-278507ff9d23",
"last_revision": "fe0a1994-daca-4c5a-98cb-ff69824c7d3d",
"state": "Fair",
"created_at": 1769132514.694757,
"updated_at": 1769132515.116709,
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "bbd281ba-eaa3-4dce-a3bd-6b9d501b07c8",
"created_at": 1769132515.134722,
"updated_at": 1769132515.134722,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf?Expires=1769218915137&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NPe0qgLoz2kZJMehjryxyF83~CIhbtf0V0Ls~hIZuLThc8yBccKpAMtAFBoSpeg9WoypAaE455HqUVyyiEgg7QQFvDJE3LvYuDZGzjj4trJljn84g2ZvZ2kKMarki-~KRzThnd5fcSNwUGb3AqMMRGBB0a9mzRK3IwYZV1EWmTAIgUvAB7-VST0jr6AreESjUD2qbHOx57F-OQyd2cqFekHsk0Tn0OCmlBHIFbuIXVIT-a9gFLobcu~OoaGeIau-G9V-IBrLHjI~D29r3EI9kbClnkrwxTHM~dWaju3SyvWjzNlelxmFO5rSZuDnOdq2bjeNNHV5UqT3tgG6g4aVtg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/submission.pdf?hash=jFzZqXtHACj12tjQFTAhB%2FVrh7qfLBmLVWVSY99QMHbEDHIoGomRvuAcnCsYB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXinAup7eUIATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"is_deletable": true,
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "cee05dd5-7a8a-4d83-8802-3172e5bada2c"
}Response
200Body
{
"code": "OK",
"data": {
"id": "1ecfcbc9-1028-48c8-b21d-76fd85e0c558",
"created_at": 1769132512.78493,
"updated_at": 1769132512.78493,
"room": {
"type": "room",
"id": "cee05dd5-7a8a-4d83-8802-3172e5bada2c",
"title": "5020 Junius Street: Test Title",
"created_at": 1769132512.773718,
"updated_at": 1769132512.870028,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/submission.pdf?hash=jFzZqXtHACj12tjQFTAhB%2FVrh7qfLBmLVWVSY99QMHbEDHIoGomRvuAcnCsYB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXigAuB1fEIATg%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: 1ecfcbc9-1028-48c8-b21d-76fd85e0c558
Request
Body
{
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"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": "0dc62b15-a5ae-4a4f-a0f8-278507ff9d23",
"last_revision": "5e9eabb4-16e1-4d1b-8e1d-9d43e25506a4",
"state": "Fair",
"created_at": 1769132514.694757,
"updated_at": 1769132514.895097,
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b223105b-c815-4d1f-98f4-8515d59fe50e",
"created_at": 1769132514.919614,
"updated_at": 1769132514.919614,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b29df140-f7fc-11f0-8c7d-09c4c6e349ce.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b29df140-f7fc-11f0-8c7d-09c4c6e349ce.pdf?Expires=1769218914923&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=RkjVOEfGsx5dVc9lu0QC3hsj5VDl4jW5mJyRsxutaHWzfkGFbr0fVhYhFoia2N7nKYHLzEtxVNWBiiIRaYOmxnix9zpfoTyY5I~nb18KKPsP8bafMwBW6MLGNdavxmGo-ww-zQRdm6w~H3xNXJLHMMpJ9sYLp6KlOgkyB8dr0-NKrIXnXa6V6Q3uRf-29yv1eD2SKsNVwsm-ZsoWRRraizRHTorp9zfE3wAE-JSZueCAQoqeqyY~aeKZ2vgwj7siaf5tz7yuYf2vQL0z~44CKjVnaj5JD7myCfxLfMxLS3sQcilse-BmdAKHORL3mqIq7fMl98oi3~ttK0q21fH47w__",
"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: 1ecfcbc9-1028-48c8-b21d-76fd85e0c558- revision
string(required) Example: 5e9eabb4-16e1-4d1b-8e1d-9d43e25506a4
Response
200Body
{
"code": "OK",
"data": {
"id": "5e9eabb4-16e1-4d1b-8e1d-9d43e25506a4",
"submission": "0dc62b15-a5ae-4a4f-a0f8-278507ff9d23",
"created_at": 1769132514.694757,
"updated_at": 1769132514.895097,
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "b223105b-c815-4d1f-98f4-8515d59fe50e"
}
}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: 1ecfcbc9-1028-48c8-b21d-76fd85e0c558
Request
Body
{
"status": "Declined",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "1ecfcbc9-1028-48c8-b21d-76fd85e0c558",
"created_at": 1769132512.78493,
"updated_at": 1769132515.455484,
"room": {
"type": "room",
"id": "cee05dd5-7a8a-4d83-8802-3172e5bada2c",
"title": "5020 Junius Street: Test Title",
"created_at": 1769132512.773718,
"updated_at": 1769132515.491187,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "0dc62b15-a5ae-4a4f-a0f8-278507ff9d23",
"last_revision": "fe0a1994-daca-4c5a-98cb-ff69824c7d3d",
"state": "Fair",
"created_at": 1769132514.694757,
"updated_at": 1769132515.116709,
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "bbd281ba-eaa3-4dce-a3bd-6b9d501b07c8",
"created_at": 1769132515.134722,
"updated_at": 1769132515.134722,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf?Expires=1769218915137&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NPe0qgLoz2kZJMehjryxyF83~CIhbtf0V0Ls~hIZuLThc8yBccKpAMtAFBoSpeg9WoypAaE455HqUVyyiEgg7QQFvDJE3LvYuDZGzjj4trJljn84g2ZvZ2kKMarki-~KRzThnd5fcSNwUGb3AqMMRGBB0a9mzRK3IwYZV1EWmTAIgUvAB7-VST0jr6AreESjUD2qbHOx57F-OQyd2cqFekHsk0Tn0OCmlBHIFbuIXVIT-a9gFLobcu~OoaGeIau-G9V-IBrLHjI~D29r3EI9kbClnkrwxTHM~dWaju3SyvWjzNlelxmFO5rSZuDnOdq2bjeNNHV5UqT3tgG6g4aVtg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "97a68f0d-34a7-4997-a151-340d7c290b31",
"created_at": 1769132515.44616,
"type": "review",
"status": "Declined",
"updated_at": 1769132515.448248
},
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/submission.pdf?hash=jFzZqXtHACj12tjQFTAhB%2FVrh7qfLBmLVWVSY99QMHbEDHIoGomRvuAcnCsYB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXinAu9zeEIATg%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: 1ecfcbc9-1028-48c8-b21d-76fd85e0c558
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "1ecfcbc9-1028-48c8-b21d-76fd85e0c558",
"created_at": 1769132512.78493,
"updated_at": 1769132515.926725,
"room": {
"type": "room",
"id": "cee05dd5-7a8a-4d83-8802-3172e5bada2c",
"title": "5020 Junius Street: Test Title",
"created_at": 1769132512.773718,
"updated_at": 1769132515.889106,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "0dc62b15-a5ae-4a4f-a0f8-278507ff9d23",
"last_revision": "fe0a1994-daca-4c5a-98cb-ff69824c7d3d",
"state": "Fair",
"created_at": 1769132514.694757,
"updated_at": 1769132515.116709,
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "bbd281ba-eaa3-4dce-a3bd-6b9d501b07c8",
"created_at": 1769132515.134722,
"updated_at": 1769132515.134722,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b2bf8300-f7fc-11f0-8c7d-09c4c6e349ce.pdf?Expires=1769218915137&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=NPe0qgLoz2kZJMehjryxyF83~CIhbtf0V0Ls~hIZuLThc8yBccKpAMtAFBoSpeg9WoypAaE455HqUVyyiEgg7QQFvDJE3LvYuDZGzjj4trJljn84g2ZvZ2kKMarki-~KRzThnd5fcSNwUGb3AqMMRGBB0a9mzRK3IwYZV1EWmTAIgUvAB7-VST0jr6AreESjUD2qbHOx57F-OQyd2cqFekHsk0Tn0OCmlBHIFbuIXVIT-a9gFLobcu~OoaGeIau-G9V-IBrLHjI~D29r3EI9kbClnkrwxTHM~dWaju3SyvWjzNlelxmFO5rSZuDnOdq2bjeNNHV5UqT3tgG6g4aVtg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "97a68f0d-34a7-4997-a151-340d7c290b31",
"created_at": 1769132515.44616,
"type": "review",
"status": "Declined",
"updated_at": 1769132515.448248
},
"form": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-01-23T01:41:55.926Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/submission.pdf?hash=jFzZqXtHACj12tjQFTAhB%2FVrh7qfLBmLVWVSY99QMHbEDHIoGomRvuAcnCsYB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXinAuB7eUIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: d416258c-7173-47da-ac34-10f27b1b754f
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "d416258c-7173-47da-ac34-10f27b1b754f",
"created_at": 1769132513.015009,
"updated_at": 1769132513.517056,
"room": {
"type": "room",
"id": "0dd31d4c-7429-4ee9-8495-01431a7a0b14",
"title": "5020 Junius Street: Another Task",
"created_at": 1769132513.00512,
"updated_at": 1769132513.095859,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/d416258c-7173-47da-ac34-10f27b1b754f/submission.pdf?hash=jFzZqXtHACj1j4mCRWF2XK9rgbuaJxmLWmILY9wBMibECnQoTIbG6rJInCpGB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXihAux0f0IATg%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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Request
Body
[
{
"id": "1ecfcbc9-1028-48c8-b21d-76fd85e0c558",
"title": "Bulk Test Title"
},
{
"id": "d416258c-7173-47da-ac34-10f27b1b754f",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "1ecfcbc9-1028-48c8-b21d-76fd85e0c558",
"created_at": 1769132512.78493,
"updated_at": 1769132513.628344,
"room": {
"type": "room",
"id": "cee05dd5-7a8a-4d83-8802-3172e5bada2c",
"title": "5020 Junius Street: Test Title",
"created_at": 1769132512.773718,
"updated_at": 1769132513.384064,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"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": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/submission.pdf?hash=jFzZqXtHACj12tjQFTAhB%2FVrh7qfLBmLVWVSY99QMHbEDHIoGomRvuAcnCsYB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXihAu50eEIATg%3D%3D"
},
{
"id": "d416258c-7173-47da-ac34-10f27b1b754f",
"created_at": 1769132513.015009,
"updated_at": 1769132513.713712,
"room": {
"type": "room",
"id": "0dd31d4c-7429-4ee9-8495-01431a7a0b14",
"title": "5020 Junius Street: Another Task",
"created_at": 1769132513.00512,
"updated_at": 1769132513.673459,
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"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": "186e3e09-ba9b-4335-b4c0-61479740bbfd",
"checklist": "7322ba26-82f9-4c55-8428-77c0c99377bd",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-01-23T01:41:53.713Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "37b52e60-c463-43aa-83be-3b57b0c9ab15",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/d416258c-7173-47da-ac34-10f27b1b754f/submission.pdf?hash=jFzZqXtHACj1j4mCRWF2XK9rgbuaJxmLWmILY9wBMibECnQoTIbG6rJInCpGB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV8aA6jJGzPu8w0pXihAu50eEIATg%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: 1ecfcbc9-1028-48c8-b21d-76fd85e0c558
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "b223105b-c815-4d1f-98f4-8515d59fe50e"
}Response
200Body
{
"code": "OK",
"data": {
"id": "30116fd0-ed50-4659-9346-7f41e4df5ebc",
"reference": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"reference_type": "User",
"created_at": 1769132515.265376,
"updated_at": 1769132515.265376,
"deleted_at": null,
"object": {
"id": "b223105b-c815-4d1f-98f4-8515d59fe50e",
"created_at": 1769132514.919614,
"updated_at": 1769132514.919614,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b29df140-f7fc-11f0-8c7d-09c4c6e349ce.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/1ecfcbc9-1028-48c8-b21d-76fd85e0c558/b29df140-f7fc-11f0-8c7d-09c4c6e349ce.pdf?Expires=1769218914923&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=RkjVOEfGsx5dVc9lu0QC3hsj5VDl4jW5mJyRsxutaHWzfkGFbr0fVhYhFoia2N7nKYHLzEtxVNWBiiIRaYOmxnix9zpfoTyY5I~nb18KKPsP8bafMwBW6MLGNdavxmGo-ww-zQRdm6w~H3xNXJLHMMpJ9sYLp6KlOgkyB8dr0-NKrIXnXa6V6Q3uRf-29yv1eD2SKsNVwsm-ZsoWRRraizRHTorp9zfE3wAE-JSZueCAQoqeqyY~aeKZ2vgwj7siaf5tz7yuYf2vQL0z~44CKjVnaj5JD7myCfxLfMxLS3sQcilse-BmdAKHORL3mqIq7fMl98oi3~ttK0q21fH47w__",
"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: 1ecfcbc9-1028-48c8-b21d-76fd85e0c558
Request
Body
{
"comment": "Comment",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "cee05dd5-7a8a-4d83-8802-3172e5bada2c"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "f332721e-b858-45ae-9280-254b3c6ba3d0",
"id": "f332721e-b858-45ae-9280-254b3c6ba3d0",
"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": 1769132510.560495,
"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": "7:41 PM - Thursday Jan 22, 2026",
"push_allowed": true,
"agents": [
{
"id": "7c27158f-606b-4b4e-815e-8861ebf1768e",
"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": 1769132510.666072,
"deleted_at": null,
"created_at": 1769132510.666072,
"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": "7088dbae-dc66-417c-bbad-23eb419d7588",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"created_at": 1769132516.381288,
"updated_at": 1769132516.381288,
"room": "cee05dd5-7a8a-4d83-8802-3172e5bada2c",
"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: d416258c-7173-47da-ac34-10f27b1b754f
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Response
200Body
{
"code": "OK",
"data": {
"id": "3b198ecb-27d2-4336-a3e0-f4f67fc67d20",
"created_at": 1769132516.88146,
"updated_at": 1769132516.88146,
"deleted_at": null,
"gallery": "b0aba5b2-f7fc-11f0-952b-d6c27ed4418a",
"name": null,
"order": 0,
"file": {
"id": "5335cf15-1b64-4250-98ef-1b01f3dda159",
"created_at": 1769132516.876922,
"updated_at": 1769132516.876922,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "37b52e60-c463-43aa-83be-3b57b0c9ab15/b3cab170-f7fc-11f0-8c7d-09c4c6e349ce.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3cab170-f7fc-11f0-8c7d-09c4c6e349ce.png",
"preview_url": "https://test.cloudfront.net/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3cab170-f7fc-11f0-8c7d-09c4c6e349ce.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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- iid
string(required) Example: 3b198ecb-27d2-4336-a3e0-f4f67fc67d20
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "5335cf15-1b64-4250-98ef-1b01f3dda159"
}Response
200Body
{
"code": "OK",
"data": {
"id": "3b198ecb-27d2-4336-a3e0-f4f67fc67d20",
"created_at": 1769132516.88146,
"updated_at": 1769132510.560495,
"deleted_at": null,
"gallery": "b0aba5b2-f7fc-11f0-952b-d6c27ed4418a",
"name": "Updated Name",
"order": 2,
"file": {
"id": "5335cf15-1b64-4250-98ef-1b01f3dda159",
"created_at": 1769132516.876922,
"updated_at": 1769132516.876922,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "37b52e60-c463-43aa-83be-3b57b0c9ab15/b3cab170-f7fc-11f0-8c7d-09c4c6e349ce.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3cab170-f7fc-11f0-8c7d-09c4c6e349ce.png",
"preview_url": "https://test.cloudfront.net/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3cab170-f7fc-11f0-8c7d-09c4c6e349ce.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: 37b52e60-c463-43aa-83be-3b57b0c9ab15- iid
string(required) Example: 3b198ecb-27d2-4336-a3e0-f4f67fc67d20
Response
200Body
{
"code": "OK",
"data": {
"id": "3b198ecb-27d2-4336-a3e0-f4f67fc67d20",
"created_at": 1769132516.88146,
"updated_at": 1769132510.560495,
"deleted_at": null,
"gallery": "b0aba5b2-f7fc-11f0-952b-d6c27ed4418a",
"name": "Updated Name",
"order": 2,
"file": {
"id": "5bdf662a-929e-4457-88e1-3a0c896d42bc",
"created_at": 1769132516.953168,
"updated_at": 1769132516.953168,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "37b52e60-c463-43aa-83be-3b57b0c9ab15/b3d6bf60-f7fc-11f0-8c7d-09c4c6e349ce.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3d6bf60-f7fc-11f0-8c7d-09c4c6e349ce.png?Expires=1769218916957&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ErWldcsJ5IFoYmj9SatEd1SMA8uQwaGI04YcJa27t1jtpaqJ3-v6xsc8tVyx0F8nBAydOR0LySrtB8zkDtVV5nuPcdiwxp-E8V0BspIorvj8El8BazyCLm2grc~H2dVmA4YUT4LdqdfdcnS9oyDIG4NvxKdjGl4oTo~DLPTATt8104aYxyiYDYVoFJ2DY7veIuslZcp9aofDnapbuUtpQi5l1Sl5mDP0jGyAHnTwav6zcRveJm1Zhq7C4Ja4AxvKRwJarOK-XqXNi0K5cq~qTtgPayVg9NZBW~3Zs-QXWqifenvfK36zvppoUyt8XUIZQAgRC2YWEpYuT4wJDYV8ew__",
"preview_url": "https://private-cdn.irish.rechat.com/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3d6bf60-f7fc-11f0-8c7d-09c4c6e349ce.png?Expires=1769218916957&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ErWldcsJ5IFoYmj9SatEd1SMA8uQwaGI04YcJa27t1jtpaqJ3-v6xsc8tVyx0F8nBAydOR0LySrtB8zkDtVV5nuPcdiwxp-E8V0BspIorvj8El8BazyCLm2grc~H2dVmA4YUT4LdqdfdcnS9oyDIG4NvxKdjGl4oTo~DLPTATt8104aYxyiYDYVoFJ2DY7veIuslZcp9aofDnapbuUtpQi5l1Sl5mDP0jGyAHnTwav6zcRveJm1Zhq7C4Ja4AxvKRwJarOK-XqXNi0K5cq~qTtgPayVg9NZBW~3Zs-QXWqifenvfK36zvppoUyt8XUIZQAgRC2YWEpYuT4wJDYV8ew__",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Request
Body
[
{
"id": "3b198ecb-27d2-4336-a3e0-f4f67fc67d20",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "3b198ecb-27d2-4336-a3e0-f4f67fc67d20",
"created_at": 1769132516.88146,
"updated_at": 1769132510.560495,
"deleted_at": 1769132510.560495,
"gallery": "b0aba5b2-f7fc-11f0-952b-d6c27ed4418a",
"name": "Updated Name",
"order": 3,
"file": {
"id": "5bdf662a-929e-4457-88e1-3a0c896d42bc",
"created_at": 1769132516.953168,
"updated_at": 1769132516.953168,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "37b52e60-c463-43aa-83be-3b57b0c9ab15/b3d6bf60-f7fc-11f0-8c7d-09c4c6e349ce.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3d6bf60-f7fc-11f0-8c7d-09c4c6e349ce.png?Expires=1769218916957&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ErWldcsJ5IFoYmj9SatEd1SMA8uQwaGI04YcJa27t1jtpaqJ3-v6xsc8tVyx0F8nBAydOR0LySrtB8zkDtVV5nuPcdiwxp-E8V0BspIorvj8El8BazyCLm2grc~H2dVmA4YUT4LdqdfdcnS9oyDIG4NvxKdjGl4oTo~DLPTATt8104aYxyiYDYVoFJ2DY7veIuslZcp9aofDnapbuUtpQi5l1Sl5mDP0jGyAHnTwav6zcRveJm1Zhq7C4Ja4AxvKRwJarOK-XqXNi0K5cq~qTtgPayVg9NZBW~3Zs-QXWqifenvfK36zvppoUyt8XUIZQAgRC2YWEpYuT4wJDYV8ew__",
"preview_url": "https://private-cdn.irish.rechat.com/37b52e60-c463-43aa-83be-3b57b0c9ab15/b3d6bf60-f7fc-11f0-8c7d-09c4c6e349ce.png?Expires=1769218916957&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ErWldcsJ5IFoYmj9SatEd1SMA8uQwaGI04YcJa27t1jtpaqJ3-v6xsc8tVyx0F8nBAydOR0LySrtB8zkDtVV5nuPcdiwxp-E8V0BspIorvj8El8BazyCLm2grc~H2dVmA4YUT4LdqdfdcnS9oyDIG4NvxKdjGl4oTo~DLPTATt8104aYxyiYDYVoFJ2DY7veIuslZcp9aofDnapbuUtpQi5l1Sl5mDP0jGyAHnTwav6zcRveJm1Zhq7C4Ja4AxvKRwJarOK-XqXNi0K5cq~qTtgPayVg9NZBW~3Zs-QXWqifenvfK36zvppoUyt8XUIZQAgRC2YWEpYuT4wJDYV8ew__",
"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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Request
Body
{
"items": [
"3b198ecb-27d2-4336-a3e0-f4f67fc67d20"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/b0aba5b2-f7fc-11f0-952b-d6c27ed4418a.zip?hash=jFzKqWRAR2CuyYeREWMiBq1z1LiAcgPZDitbf9tSLCvcCSZjGofH6ecazSoUFHzkkxDSPuwS29FDCKVDtEbmgEfBX7kWJ5cSkh3puldnfF9wg5WxjiM9LFcybr1WdrfQEGPBAzRU3EZ2R6d7aAyhXW7N1cg0pXmjFux0YCgVBlKFCeqzv8aof7YNuyS913XP3mBMWjhO4U%2FY1X1y4LsjqDV2tfchFg8F%2FGCcWhE4rimbE7M%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: 37b52e60-c463-43aa-83be-3b57b0c9ab15
Response
200Body
{
"code": "OK",
"data": {
"id": "79ff57d7-1bc3-460a-a0ec-e9f0bba43a4c",
"created_at": 1769132517.315084,
"updated_at": 1769132517.315084,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/37b52e60-c463-43aa-83be-3b57b0c9ab15/b40c9c70-f7fc-11f0-8c7d-09c4c6e349ce.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/37b52e60-c463-43aa-83be-3b57b0c9ab15/b40c9c70-f7fc-11f0-8c7d-09c4c6e349ce.zip?Expires=1769218917318&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=d85a714wVPic~vmS8YDZ9i75FG~2wSDRtZYdl4rMNpt-zx-f90EepsfxcADto3jxDcD1cb5-cRo6mhBDmmSWaaL7C26E6McsCh~WS6TbJZ7HHD0LDqC6xrwOTmWtYXfb8tgAaqsG4QUuLZXDHdjq8grLlLGlVcDqD8DD4xg4clv5mvMFbF3wNPMmZIkrhMm-hLQ1Iod0mU5YOd747O2FvM91V3HPxrBstN-AbWzW0HaryMFWpH4WKzc-zsLZIGdS4qMAySkhWlzwdwaowdKcPy8hSwX2dYy2Na36knrXt4Q6oh3va73bkJ0qyMyTuOS2iRcc7Xx5KRiGwa7urPmsqA__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}