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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Response
200Body
{
"code": "OK",
"data": {
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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-02-03T20:39:04.568Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "72dfc864-0d84-410d-9df4-95a916cd95a1",
"created_at": 1770151144.648048,
"updated_at": 1770151144.648048,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "1bde99d6-e836-4c09-969b-d4425d02c46b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "f9a536d0-9db8-44f2-9cae-c0c84bd6b1da",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "5739729c-f838-4322-b10f-d1542261b2d6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "320c2409-7744-4f0e-a1ed-b86688fb6449",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "15a07329-31a1-42ab-8291-7a8a5290e1d1",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "30365385-4909-4c43-aae6-9ac7146ea89e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "569bdf05-2cee-4e79-9018-53c50d571078",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "ecc79829-539c-46c5-9c62-fb0725175008",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d0f52d6c-efba-440a-aec2-2eb03ce2d929",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "c9044d8f-23a3-4ea6-80ca-b7a6777b9d5a",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "52c0b301-2f4b-4622-a51c-81d79c14923e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "fed3bfcc-42fc-413c-8d11-7625b21d3163",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "96746717-ccdb-484a-b593-c61a88dceb50",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d9304499-feb8-43e9-9d76-a56436e24a3c",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "63bf85c5-919f-4d3c-a7b6-45d56dcfa571",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "24dea3eb-d0e5-4c2e-b7ef-3582a932e95f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "117bd05f-ce71-4085-add2-6aec08990279",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "001a119a-2042-40ac-a664-e3c2aff47272",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "682cf7d5-ac24-4907-bfaa-864497d2966f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "6fa0cd30-1f91-4396-a46b-accda3e993bd",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "e0ccb72d-7c58-4fb8-8239-4a6aef4af71b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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-02-03T20:39:04.568Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "72dfc864-0d84-410d-9df4-95a916cd95a1",
"created_at": 1770151144.648048,
"updated_at": 1770151144.648048,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "1bde99d6-e836-4c09-969b-d4425d02c46b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "f9a536d0-9db8-44f2-9cae-c0c84bd6b1da",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "5739729c-f838-4322-b10f-d1542261b2d6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "320c2409-7744-4f0e-a1ed-b86688fb6449",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "15a07329-31a1-42ab-8291-7a8a5290e1d1",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "30365385-4909-4c43-aae6-9ac7146ea89e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "569bdf05-2cee-4e79-9018-53c50d571078",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "ecc79829-539c-46c5-9c62-fb0725175008",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d0f52d6c-efba-440a-aec2-2eb03ce2d929",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "c9044d8f-23a3-4ea6-80ca-b7a6777b9d5a",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "52c0b301-2f4b-4622-a51c-81d79c14923e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "fed3bfcc-42fc-413c-8d11-7625b21d3163",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "96746717-ccdb-484a-b593-c61a88dceb50",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d9304499-feb8-43e9-9d76-a56436e24a3c",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "63bf85c5-919f-4d3c-a7b6-45d56dcfa571",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "24dea3eb-d0e5-4c2e-b7ef-3582a932e95f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "117bd05f-ce71-4085-add2-6aec08990279",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "001a119a-2042-40ac-a664-e3c2aff47272",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "682cf7d5-ac24-4907-bfaa-864497d2966f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "6fa0cd30-1f91-4396-a46b-accda3e993bd",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "e0ccb72d-7c58-4fb8-8239-4a6aef4af71b",
"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: e195291b-67b0-4fe5-ab31-1f5003d465e0
Response
200Body
{
"code": "OK",
"data": [
{
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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-02-03T20:39:04.568Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "72dfc864-0d84-410d-9df4-95a916cd95a1",
"created_at": 1770151144.648048,
"updated_at": 1770151144.648048,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "1bde99d6-e836-4c09-969b-d4425d02c46b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "f9a536d0-9db8-44f2-9cae-c0c84bd6b1da",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "5739729c-f838-4322-b10f-d1542261b2d6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "320c2409-7744-4f0e-a1ed-b86688fb6449",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "15a07329-31a1-42ab-8291-7a8a5290e1d1",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "30365385-4909-4c43-aae6-9ac7146ea89e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "569bdf05-2cee-4e79-9018-53c50d571078",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "ecc79829-539c-46c5-9c62-fb0725175008",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d0f52d6c-efba-440a-aec2-2eb03ce2d929",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "c9044d8f-23a3-4ea6-80ca-b7a6777b9d5a",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "52c0b301-2f4b-4622-a51c-81d79c14923e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "fed3bfcc-42fc-413c-8d11-7625b21d3163",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "96746717-ccdb-484a-b593-c61a88dceb50",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d9304499-feb8-43e9-9d76-a56436e24a3c",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "63bf85c5-919f-4d3c-a7b6-45d56dcfa571",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "24dea3eb-d0e5-4c2e-b7ef-3582a932e95f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "117bd05f-ce71-4085-add2-6aec08990279",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "001a119a-2042-40ac-a664-e3c2aff47272",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "682cf7d5-ac24-4907-bfaa-864497d2966f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "6fa0cd30-1f91-4396-a46b-accda3e993bd",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "e0ccb72d-7c58-4fb8-8239-4a6aef4af71b",
"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: e195291b-67b0-4fe5-ab31-1f5003d465e0
Response
200Body
{
"code": "OK",
"data": [
{
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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-02-03T20:39:04.568Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1770151148.41122,
"is_draft": false,
"roles": [
{
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "72dfc864-0d84-410d-9df4-95a916cd95a1",
"created_at": 1770151144.648048,
"updated_at": 1770151144.648048,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "1bde99d6-e836-4c09-969b-d4425d02c46b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "f9a536d0-9db8-44f2-9cae-c0c84bd6b1da",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "5739729c-f838-4322-b10f-d1542261b2d6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "320c2409-7744-4f0e-a1ed-b86688fb6449",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "15a07329-31a1-42ab-8291-7a8a5290e1d1",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "30365385-4909-4c43-aae6-9ac7146ea89e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "569bdf05-2cee-4e79-9018-53c50d571078",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "ecc79829-539c-46c5-9c62-fb0725175008",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d0f52d6c-efba-440a-aec2-2eb03ce2d929",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "c9044d8f-23a3-4ea6-80ca-b7a6777b9d5a",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "52c0b301-2f4b-4622-a51c-81d79c14923e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "fed3bfcc-42fc-413c-8d11-7625b21d3163",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "96746717-ccdb-484a-b593-c61a88dceb50",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d9304499-feb8-43e9-9d76-a56436e24a3c",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "63bf85c5-919f-4d3c-a7b6-45d56dcfa571",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "24dea3eb-d0e5-4c2e-b7ef-3582a932e95f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "117bd05f-ce71-4085-add2-6aec08990279",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "001a119a-2042-40ac-a664-e3c2aff47272",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "682cf7d5-ac24-4907-bfaa-864497d2966f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "6fa0cd30-1f91-4396-a46b-accda3e993bd",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "e0ccb72d-7c58-4fb8-8239-4a6aef4af71b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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-02-03T20:39:04.568Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "72dfc864-0d84-410d-9df4-95a916cd95a1",
"created_at": 1770151144.648048,
"updated_at": 1770151144.648048,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "1bde99d6-e836-4c09-969b-d4425d02c46b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "f9a536d0-9db8-44f2-9cae-c0c84bd6b1da",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "5739729c-f838-4322-b10f-d1542261b2d6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "320c2409-7744-4f0e-a1ed-b86688fb6449",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "15a07329-31a1-42ab-8291-7a8a5290e1d1",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "30365385-4909-4c43-aae6-9ac7146ea89e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "569bdf05-2cee-4e79-9018-53c50d571078",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "ecc79829-539c-46c5-9c62-fb0725175008",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d0f52d6c-efba-440a-aec2-2eb03ce2d929",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "c9044d8f-23a3-4ea6-80ca-b7a6777b9d5a",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "52c0b301-2f4b-4622-a51c-81d79c14923e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "fed3bfcc-42fc-413c-8d11-7625b21d3163",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "96746717-ccdb-484a-b593-c61a88dceb50",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d9304499-feb8-43e9-9d76-a56436e24a3c",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "63bf85c5-919f-4d3c-a7b6-45d56dcfa571",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "24dea3eb-d0e5-4c2e-b7ef-3582a932e95f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "117bd05f-ce71-4085-add2-6aec08990279",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "001a119a-2042-40ac-a664-e3c2aff47272",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "682cf7d5-ac24-4907-bfaa-864497d2966f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "6fa0cd30-1f91-4396-a46b-accda3e993bd",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "e0ccb72d-7c58-4fb8-8239-4a6aef4af71b",
"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": "2412f7fb-53b6-4454-877d-4e9be58d5eda"
}Response
200Body
{
"code": "OK",
"data": {
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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": "60f20a3c-0140-11f1-a485-ceef6dd546fe",
"created_at": 1770151144.120584,
"updated_at": 1770151144.120584,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"created_at": 1770151143.938652,
"updated_at": 1770151143.938652,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "37f44a63-5777-4b59-843d-f96e7148c6a4",
"created_at": 1770151143.030549,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "e3dc4341-4c53-404b-a11d-3963d67243c4",
"created_at": 1770151143.030549,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "5a5a335a-f185-44c9-b94f-2bc6b8e45e1e",
"created_at": 1770151143.030549,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "72dfc864-0d84-410d-9df4-95a916cd95a1",
"created_at": 1770151144.648048,
"updated_at": 1770151144.648048,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- rid
string(required) Example: cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9"
}Response
200Body
{
"code": "OK",
"data": {
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "1bde99d6-e836-4c09-969b-d4425d02c46b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "f9a536d0-9db8-44f2-9cae-c0c84bd6b1da",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "5739729c-f838-4322-b10f-d1542261b2d6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "320c2409-7744-4f0e-a1ed-b86688fb6449",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "15a07329-31a1-42ab-8291-7a8a5290e1d1",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "30365385-4909-4c43-aae6-9ac7146ea89e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "569bdf05-2cee-4e79-9018-53c50d571078",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "ecc79829-539c-46c5-9c62-fb0725175008",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d0f52d6c-efba-440a-aec2-2eb03ce2d929",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "c9044d8f-23a3-4ea6-80ca-b7a6777b9d5a",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "52c0b301-2f4b-4622-a51c-81d79c14923e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "fed3bfcc-42fc-413c-8d11-7625b21d3163",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "96746717-ccdb-484a-b593-c61a88dceb50",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d9304499-feb8-43e9-9d76-a56436e24a3c",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "63bf85c5-919f-4d3c-a7b6-45d56dcfa571",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "24dea3eb-d0e5-4c2e-b7ef-3582a932e95f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "117bd05f-ce71-4085-add2-6aec08990279",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "001a119a-2042-40ac-a664-e3c2aff47272",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "682cf7d5-ac24-4907-bfaa-864497d2966f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "6fa0cd30-1f91-4396-a46b-accda3e993bd",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "e0ccb72d-7c58-4fb8-8239-4a6aef4af71b",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda"
}Response
200Body
{
"code": "OK",
"data": {
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"created_at": 1770151143.938652,
"updated_at": 1770151143.938652,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "37f44a63-5777-4b59-843d-f96e7148c6a4",
"created_at": 1770151143.030549,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "e3dc4341-4c53-404b-a11d-3963d67243c4",
"created_at": 1770151143.030549,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "5a5a335a-f185-44c9-b94f-2bc6b8e45e1e",
"created_at": 1770151143.030549,
"deleted_at": null,
"brand": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "1bde99d6-e836-4c09-969b-d4425d02c46b",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "f9a536d0-9db8-44f2-9cae-c0c84bd6b1da",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "5739729c-f838-4322-b10f-d1542261b2d6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "320c2409-7744-4f0e-a1ed-b86688fb6449",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "15a07329-31a1-42ab-8291-7a8a5290e1d1",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "30365385-4909-4c43-aae6-9ac7146ea89e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "569bdf05-2cee-4e79-9018-53c50d571078",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "ecc79829-539c-46c5-9c62-fb0725175008",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d0f52d6c-efba-440a-aec2-2eb03ce2d929",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "c9044d8f-23a3-4ea6-80ca-b7a6777b9d5a",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "52c0b301-2f4b-4622-a51c-81d79c14923e",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "fed3bfcc-42fc-413c-8d11-7625b21d3163",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "96746717-ccdb-484a-b593-c61a88dceb50",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "d9304499-feb8-43e9-9d76-a56436e24a3c",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "63bf85c5-919f-4d3c-a7b6-45d56dcfa571",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "24dea3eb-d0e5-4c2e-b7ef-3582a932e95f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "117bd05f-ce71-4085-add2-6aec08990279",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "001a119a-2042-40ac-a664-e3c2aff47272",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "682cf7d5-ac24-4907-bfaa-864497d2966f",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "6fa0cd30-1f91-4396-a46b-accda3e993bd",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "MLS",
"definition": "e0ccb72d-7c58-4fb8-8239-4a6aef4af71b",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Request
Body
{
"context": [
{
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"value": "2017/12/06"
},
{
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- cid
string(required) Example: 152b3205-948f-43f6-a09b-6cc4c6df177c
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_at": 1770151144.120495,
"updated_at": 1770151144.120495,
"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": "6b008826-0bbe-4c80-b889-3f836806a09c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "f27c3146-3c02-4453-b7a0-89ca115fe318",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": null,
"source": "PropertyType",
"definition": "b59ba097-25ab-4234-896d-5c17ffd63081",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": "2026-02-03T20:39:03.030549+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-02-03T20:39:04.333474+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"source": "Provided",
"definition": "8d871783-8f97-4496-a7c1-2b4877ba49e6",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "152b3205-948f-43f6-a09b-6cc4c6df177c",
"type": "deal_context_item",
"created_at": 1770151143.030549,
"approved_at": 1770151144.333474,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0"
}
],
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9",
"created_at": 1770151144.645637,
"updated_at": 1770151144.645637,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "72dfc864-0d84-410d-9df4-95a916cd95a1",
"created_at": 1770151144.648048,
"updated_at": 1770151144.648048,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- rid
string(required) Example: cec0cb2a-6f14-4cc7-91e9-7074e6af1bd9
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "2412f7fb-53b6-4454-877d-4e9be58d5eda"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "923a8394-ef15-4ee8-a094-540dee535cc0",
"created_at": 1770151143.030549,
"updated_at": 1770151143.030549,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"order": 1,
"origin": "5a5a335a-f185-44c9-b94f-2bc6b8e45e1e",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- cid
string(required) Example: 923a8394-ef15-4ee8-a094-540dee535cc0
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "923a8394-ef15-4ee8-a094-540dee535cc0"
}Response
200Body
{
"code": "OK",
"data": {
"id": "923a8394-ef15-4ee8-a094-540dee535cc0",
"created_at": 1770151143.030549,
"updated_at": 1770151143.030549,
"deleted_at": null,
"deactivated_at": "2026-02-03T20:39:08.755Z",
"title": "Updated Checklist 1",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"order": 3,
"origin": "5a5a335a-f185-44c9-b94f-2bc6b8e45e1e",
"terminated_at": "2026-02-03T20:39:08.755Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "e7bf6bef-4571-4fa1-9e94-36c5c2a12e51",
"created_at": 1770151145.251705,
"updated_at": 1770151148.660145,
"room": {
"type": "room",
"id": "2f76bcad-f237-486a-9162-314bd904e404",
"title": "5020 Junius Street: Test Title",
"created_at": 1770151145.239431,
"updated_at": 1770151148.363813,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "a2141861-72d8-4273-a835-cb267ba3eb3a",
"last_revision": "50fc90c8-4107-4af4-83cc-3b63c2f805eb",
"state": "Fair",
"created_at": 1770151147.223336,
"updated_at": 1770151147.636709,
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b2238dda-d6fd-4e40-8c9d-899d2e3160bf",
"created_at": 1770151147.655927,
"updated_at": 1770151147.655927,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf?Expires=1770237547660&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SAB2loGMz083rvDbnpPIPjuJ4miTQb6ui13aqqIOjbNAl6Y-YcvVyAlRn~xi9FOe10YlalAmtyyFR1cmC1B5OcwQzfPMBnK27MqEFf8ddmSPDV-eYDW~D9EzoKHvBts6zDG6c~9Ji3nWzhqqkE-XqSXLdAR1E2wcK9QYCxYdE2QhOhWdEY5A5kti6GSu5mzPbvIuk0SyeB6EMSQ3YiThABFgcHHb~7G5JIThy3tTs6JjPFVu~lg6ZsLNHIuPlMMwiSgtgavG5RPYHtphDQUI9xMGHoAV2kMlb9AKflGjx4-KwnJijDSQ5dQ7A0feePoKyuWsyuK2BcQdaqzph~JdOA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "be525c4e-eb8f-4f72-9d37-69f5bcc74c4e",
"created_at": 1770151147.955727,
"type": "review",
"status": "Declined",
"updated_at": 1770151147.957352
},
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/submission.pdf?hash=jFzZqXtHACj1jorRFWUhAaprgr%2BaJRmLC2dbY4QHOCbECHItS9KWuuFNzCsRB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2qAuFye0IATg%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: e7bf6bef-4571-4fa1-9e94-36c5c2a12e51
Response
200Body
{
"code": "OK",
"data": {
"id": "e7bf6bef-4571-4fa1-9e94-36c5c2a12e51",
"created_at": 1770151145.251705,
"updated_at": 1770151147.259434,
"room": {
"type": "room",
"id": "2f76bcad-f237-486a-9162-314bd904e404",
"title": "5020 Junius Street: Test Title",
"created_at": 1770151145.239431,
"updated_at": 1770151147.810885,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "a2141861-72d8-4273-a835-cb267ba3eb3a",
"last_revision": "50fc90c8-4107-4af4-83cc-3b63c2f805eb",
"state": "Fair",
"created_at": 1770151147.223336,
"updated_at": 1770151147.636709,
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b2238dda-d6fd-4e40-8c9d-899d2e3160bf",
"created_at": 1770151147.655927,
"updated_at": 1770151147.655927,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf?Expires=1770237547660&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SAB2loGMz083rvDbnpPIPjuJ4miTQb6ui13aqqIOjbNAl6Y-YcvVyAlRn~xi9FOe10YlalAmtyyFR1cmC1B5OcwQzfPMBnK27MqEFf8ddmSPDV-eYDW~D9EzoKHvBts6zDG6c~9Ji3nWzhqqkE-XqSXLdAR1E2wcK9QYCxYdE2QhOhWdEY5A5kti6GSu5mzPbvIuk0SyeB6EMSQ3YiThABFgcHHb~7G5JIThy3tTs6JjPFVu~lg6ZsLNHIuPlMMwiSgtgavG5RPYHtphDQUI9xMGHoAV2kMlb9AKflGjx4-KwnJijDSQ5dQ7A0feePoKyuWsyuK2BcQdaqzph~JdOA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/submission.pdf?hash=jFzZqXtHACj1jorRFWUhAaprgr%2BaJRmLC2dbY4QHOCbECHItS9KWuuFNzCsRB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2lAuByfUIATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"is_deletable": true,
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "2f76bcad-f237-486a-9162-314bd904e404"
}Response
200Body
{
"code": "OK",
"data": {
"id": "e7bf6bef-4571-4fa1-9e94-36c5c2a12e51",
"created_at": 1770151145.251705,
"updated_at": 1770151145.251705,
"room": {
"type": "room",
"id": "2f76bcad-f237-486a-9162-314bd904e404",
"title": "5020 Junius Street: Test Title",
"created_at": 1770151145.239431,
"updated_at": 1770151145.322193,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/submission.pdf?hash=jFzZqXtHACj1jorRFWUhAaprgr%2BaJRmLC2dbY4QHOCbECHItS9KWuuFNzCsRB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2nAu1yfkIATg%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: e7bf6bef-4571-4fa1-9e94-36c5c2a12e51
Request
Body
{
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"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": "a2141861-72d8-4273-a835-cb267ba3eb3a",
"last_revision": "9b51069f-6fe1-4702-865e-2b65a02c83d0",
"state": "Fair",
"created_at": 1770151147.223336,
"updated_at": 1770151147.416733,
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "0bc9a10a-7cdf-4ed2-b505-76eaa24e78df",
"created_at": 1770151147.44199,
"updated_at": 1770151147.44199,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/62ea1a00-0140-11f1-bb7b-c1ce1696c2c7.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/62ea1a00-0140-11f1-bb7b-c1ce1696c2c7.pdf?Expires=1770237547445&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=hv7rpaf57EXjQ~1483gv5oiBZlH25Kk6boMS-UFilK7xmtyiKH6l016GPMI04tlWTP75fbuHqUbggzWQNwiuWUeNm59l~qOjKQN0OErgoURDgi7hf6tgNJI2se~LaKRZcc6EiXHz2j233AtBND7qSwrkeIAHFLFyx2G7kiDbuJ7h8YJKj72DnrDN6a29jawkaSPLJyEiTWLJD235OFMDkdBhffgYjQIb~TJkTv~-1DnGn-CHur7iXroXJbL7o0cpZtMmjIaDoHiVMfqxUfuQWlF7yViZkMaY2cc5Hg8YfyL8TUXnAgOd3jMSe-j5dLl07Iv9Z-0Iny0E0SZZpV0zPg__",
"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: e7bf6bef-4571-4fa1-9e94-36c5c2a12e51- revision
string(required) Example: 9b51069f-6fe1-4702-865e-2b65a02c83d0
Response
200Body
{
"code": "OK",
"data": {
"id": "9b51069f-6fe1-4702-865e-2b65a02c83d0",
"submission": "a2141861-72d8-4273-a835-cb267ba3eb3a",
"created_at": 1770151147.223336,
"updated_at": 1770151147.416733,
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "0bc9a10a-7cdf-4ed2-b505-76eaa24e78df"
}
}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: e7bf6bef-4571-4fa1-9e94-36c5c2a12e51
Request
Body
{
"status": "Declined",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "e7bf6bef-4571-4fa1-9e94-36c5c2a12e51",
"created_at": 1770151145.251705,
"updated_at": 1770151147.964482,
"room": {
"type": "room",
"id": "2f76bcad-f237-486a-9162-314bd904e404",
"title": "5020 Junius Street: Test Title",
"created_at": 1770151145.239431,
"updated_at": 1770151147.99301,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "a2141861-72d8-4273-a835-cb267ba3eb3a",
"last_revision": "50fc90c8-4107-4af4-83cc-3b63c2f805eb",
"state": "Fair",
"created_at": 1770151147.223336,
"updated_at": 1770151147.636709,
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b2238dda-d6fd-4e40-8c9d-899d2e3160bf",
"created_at": 1770151147.655927,
"updated_at": 1770151147.655927,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf?Expires=1770237547660&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SAB2loGMz083rvDbnpPIPjuJ4miTQb6ui13aqqIOjbNAl6Y-YcvVyAlRn~xi9FOe10YlalAmtyyFR1cmC1B5OcwQzfPMBnK27MqEFf8ddmSPDV-eYDW~D9EzoKHvBts6zDG6c~9Ji3nWzhqqkE-XqSXLdAR1E2wcK9QYCxYdE2QhOhWdEY5A5kti6GSu5mzPbvIuk0SyeB6EMSQ3YiThABFgcHHb~7G5JIThy3tTs6JjPFVu~lg6ZsLNHIuPlMMwiSgtgavG5RPYHtphDQUI9xMGHoAV2kMlb9AKflGjx4-KwnJijDSQ5dQ7A0feePoKyuWsyuK2BcQdaqzph~JdOA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "be525c4e-eb8f-4f72-9d37-69f5bcc74c4e",
"created_at": 1770151147.955727,
"type": "review",
"status": "Declined",
"updated_at": 1770151147.957352
},
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/submission.pdf?hash=jFzZqXtHACj1jorRFWUhAaprgr%2BaJRmLC2dbY4QHOCbECHItS9KWuuFNzCsRB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2qAul7eEIATg%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: e7bf6bef-4571-4fa1-9e94-36c5c2a12e51
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "e7bf6bef-4571-4fa1-9e94-36c5c2a12e51",
"created_at": 1770151145.251705,
"updated_at": 1770151148.41122,
"room": {
"type": "room",
"id": "2f76bcad-f237-486a-9162-314bd904e404",
"title": "5020 Junius Street: Test Title",
"created_at": 1770151145.239431,
"updated_at": 1770151148.363813,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "a2141861-72d8-4273-a835-cb267ba3eb3a",
"last_revision": "50fc90c8-4107-4af4-83cc-3b63c2f805eb",
"state": "Fair",
"created_at": 1770151147.223336,
"updated_at": 1770151147.636709,
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "b2238dda-d6fd-4e40-8c9d-899d2e3160bf",
"created_at": 1770151147.655927,
"updated_at": 1770151147.655927,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/630b3690-0140-11f1-bb7b-c1ce1696c2c7.pdf?Expires=1770237547660&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=SAB2loGMz083rvDbnpPIPjuJ4miTQb6ui13aqqIOjbNAl6Y-YcvVyAlRn~xi9FOe10YlalAmtyyFR1cmC1B5OcwQzfPMBnK27MqEFf8ddmSPDV-eYDW~D9EzoKHvBts6zDG6c~9Ji3nWzhqqkE-XqSXLdAR1E2wcK9QYCxYdE2QhOhWdEY5A5kti6GSu5mzPbvIuk0SyeB6EMSQ3YiThABFgcHHb~7G5JIThy3tTs6JjPFVu~lg6ZsLNHIuPlMMwiSgtgavG5RPYHtphDQUI9xMGHoAV2kMlb9AKflGjx4-KwnJijDSQ5dQ7A0feePoKyuWsyuK2BcQdaqzph~JdOA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "be525c4e-eb8f-4f72-9d37-69f5bcc74c4e",
"created_at": 1770151147.955727,
"type": "review",
"status": "Declined",
"updated_at": 1770151147.957352
},
"form": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-02-03T20:39:08.411Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/submission.pdf?hash=jFzZqXtHACj1jorRFWUhAaprgr%2BaJRmLC2dbY4QHOCbECHItS9KWuuFNzCsRB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2qAuxyeUIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: a32ff048-00c3-4c87-a485-7b836a4e6580
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "a32ff048-00c3-4c87-a485-7b836a4e6580",
"created_at": 1770151145.486332,
"updated_at": 1770151146.022421,
"room": {
"type": "room",
"id": "5e2e653f-26a7-474c-b5a7-9c8d13a345dd",
"title": "5020 Junius Street: Another Task",
"created_at": 1770151145.476441,
"updated_at": 1770151145.567401,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/a32ff048-00c3-4c87-a485-7b836a4e6580/submission.pdf?hash=jFzZqXtHACj1io6BFTVzUPRrhrrOJxmLDj5dY9xWOSfEDCZ2TYfF77VJnCYQB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2kAul7eUIATg%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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Request
Body
[
{
"id": "e7bf6bef-4571-4fa1-9e94-36c5c2a12e51",
"title": "Bulk Test Title"
},
{
"id": "a32ff048-00c3-4c87-a485-7b836a4e6580",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "e7bf6bef-4571-4fa1-9e94-36c5c2a12e51",
"created_at": 1770151145.251705,
"updated_at": 1770151146.150031,
"room": {
"type": "room",
"id": "2f76bcad-f237-486a-9162-314bd904e404",
"title": "5020 Junius Street: Test Title",
"created_at": 1770151145.239431,
"updated_at": 1770151145.874139,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"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": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/submission.pdf?hash=jFzZqXtHACj1jorRFWUhAaprgr%2BaJRmLC2dbY4QHOCbECHItS9KWuuFNzCsRB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2kAut6eUIATg%3D%3D"
},
{
"id": "a32ff048-00c3-4c87-a485-7b836a4e6580",
"created_at": 1770151145.486332,
"updated_at": 1770151146.24651,
"room": {
"type": "room",
"id": "5e2e653f-26a7-474c-b5a7-9c8d13a345dd",
"title": "5020 Junius Street: Another Task",
"created_at": 1770151145.476441,
"updated_at": 1770151146.198545,
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"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": "acfc99a3-c46d-4d37-8f52-300bc854d3f6",
"checklist": "923a8394-ef15-4ee8-a094-540dee535cc0",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-02-03T20:39:06.246Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/a32ff048-00c3-4c87-a485-7b836a4e6580/submission.pdf?hash=jFzZqXtHACj1io6BFTVzUPRrhrrOJxmLDj5dY9xWOSfEDCZ2TYfF77VJnCYQB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV%2FaAyjJG7Ou8s8pX2kAut6dkIATg%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: e7bf6bef-4571-4fa1-9e94-36c5c2a12e51
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "0bc9a10a-7cdf-4ed2-b505-76eaa24e78df"
}Response
200Body
{
"code": "OK",
"data": {
"id": "0042d022-a396-4c6c-8159-ae3cbaacd75d",
"reference": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"reference_type": "User",
"created_at": 1770151147.796616,
"updated_at": 1770151147.796616,
"deleted_at": null,
"object": {
"id": "0bc9a10a-7cdf-4ed2-b505-76eaa24e78df",
"created_at": 1770151147.44199,
"updated_at": 1770151147.44199,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/62ea1a00-0140-11f1-bb7b-c1ce1696c2c7.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/e7bf6bef-4571-4fa1-9e94-36c5c2a12e51/62ea1a00-0140-11f1-bb7b-c1ce1696c2c7.pdf?Expires=1770237547445&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=hv7rpaf57EXjQ~1483gv5oiBZlH25Kk6boMS-UFilK7xmtyiKH6l016GPMI04tlWTP75fbuHqUbggzWQNwiuWUeNm59l~qOjKQN0OErgoURDgi7hf6tgNJI2se~LaKRZcc6EiXHz2j233AtBND7qSwrkeIAHFLFyx2G7kiDbuJ7h8YJKj72DnrDN6a29jawkaSPLJyEiTWLJD235OFMDkdBhffgYjQIb~TJkTv~-1DnGn-CHur7iXroXJbL7o0cpZtMmjIaDoHiVMfqxUfuQWlF7yViZkMaY2cc5Hg8YfyL8TUXnAgOd3jMSe-j5dLl07Iv9Z-0Iny0E0SZZpV0zPg__",
"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: e7bf6bef-4571-4fa1-9e94-36c5c2a12e51
Request
Body
{
"comment": "Comment",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "2f76bcad-f237-486a-9162-314bd904e404"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "5e537348-e6b0-457f-8623-328b81f6dc74",
"id": "5e537348-e6b0-457f-8623-328b81f6dc74",
"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": 1770151143.030549,
"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": "2:39 PM - Tuesday Feb 03, 2026",
"push_allowed": true,
"agents": [
{
"id": "d95bec56-5c23-47c0-a30a-aa70d1e3924c",
"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": 1770151143.153522,
"deleted_at": null,
"created_at": 1770151143.153522,
"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": "e195291b-67b0-4fe5-ab31-1f5003d465e0",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"created_at": 1770151148.870351,
"updated_at": 1770151148.870351,
"room": "2f76bcad-f237-486a-9162-314bd904e404",
"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: a32ff048-00c3-4c87-a485-7b836a4e6580
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Response
200Body
{
"code": "OK",
"data": {
"id": "24bf4274-f25f-414c-b024-661e8bb04164",
"created_at": 1770151149.322767,
"updated_at": 1770151149.322767,
"deleted_at": null,
"gallery": "60f20a3c-0140-11f1-a485-ceef6dd546fe",
"name": null,
"order": 0,
"file": {
"id": "a3de5e7b-f8b4-4cad-98eb-e22cbb08b251",
"created_at": 1770151149.318114,
"updated_at": 1770151149.318114,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/640aa530-0140-11f1-bb7b-c1ce1696c2c7.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/640aa530-0140-11f1-bb7b-c1ce1696c2c7.png",
"preview_url": "https://test.cloudfront.net/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/640aa530-0140-11f1-bb7b-c1ce1696c2c7.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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- iid
string(required) Example: 24bf4274-f25f-414c-b024-661e8bb04164
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "a3de5e7b-f8b4-4cad-98eb-e22cbb08b251"
}Response
200Body
{
"code": "OK",
"data": {
"id": "24bf4274-f25f-414c-b024-661e8bb04164",
"created_at": 1770151149.322767,
"updated_at": 1770151143.030549,
"deleted_at": null,
"gallery": "60f20a3c-0140-11f1-a485-ceef6dd546fe",
"name": "Updated Name",
"order": 2,
"file": {
"id": "a3de5e7b-f8b4-4cad-98eb-e22cbb08b251",
"created_at": 1770151149.318114,
"updated_at": 1770151149.318114,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/640aa530-0140-11f1-bb7b-c1ce1696c2c7.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/640aa530-0140-11f1-bb7b-c1ce1696c2c7.png",
"preview_url": "https://test.cloudfront.net/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/640aa530-0140-11f1-bb7b-c1ce1696c2c7.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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e- iid
string(required) Example: 24bf4274-f25f-414c-b024-661e8bb04164
Response
200Body
{
"code": "OK",
"data": {
"id": "24bf4274-f25f-414c-b024-661e8bb04164",
"created_at": 1770151149.322767,
"updated_at": 1770151143.030549,
"deleted_at": null,
"gallery": "60f20a3c-0140-11f1-a485-ceef6dd546fe",
"name": "Updated Name",
"order": 2,
"file": {
"id": "6a53fc6a-06d3-4582-a104-ca9a38e1f2ba",
"created_at": 1770151149.40931,
"updated_at": 1770151149.40931,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/641887e0-0140-11f1-bb7b-c1ce1696c2c7.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/641887e0-0140-11f1-bb7b-c1ce1696c2c7.png?Expires=1770237549412&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ToLdDkjtCLKUlp-6HM9b~TBTb40UdbKB~RdJFp2oi70mo4Ka-HHtEKW2A3T3k2EYewb90lZalxfqDDNP70Ces~hsSc4-wGvSTd8a2DkpBgXgZeydfBlmoCXxaM~MgtXFVareSogR2ErY5ChQ3pFW87hXGv~eYrTg6-nkzJVry4sZK8EFdUlM-0zZ0sqUsgdBY5AAHoweZGkOjEz5nK9pyuF-7fYMf8VDEEerj9ggn1Vc48pJNwah4j-pXMI5wX99aqJYMcC~czVyrzcLFLm6YSXWBZC2PWBby-IMo6Of2qNLZpkfvnFbPEbJuN3DxuSlqMKd2PEMIHMt0Ggp7fKV8Q__",
"preview_url": "https://private-cdn.irish.rechat.com/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/641887e0-0140-11f1-bb7b-c1ce1696c2c7.png?Expires=1770237549412&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ToLdDkjtCLKUlp-6HM9b~TBTb40UdbKB~RdJFp2oi70mo4Ka-HHtEKW2A3T3k2EYewb90lZalxfqDDNP70Ces~hsSc4-wGvSTd8a2DkpBgXgZeydfBlmoCXxaM~MgtXFVareSogR2ErY5ChQ3pFW87hXGv~eYrTg6-nkzJVry4sZK8EFdUlM-0zZ0sqUsgdBY5AAHoweZGkOjEz5nK9pyuF-7fYMf8VDEEerj9ggn1Vc48pJNwah4j-pXMI5wX99aqJYMcC~czVyrzcLFLm6YSXWBZC2PWBby-IMo6Of2qNLZpkfvnFbPEbJuN3DxuSlqMKd2PEMIHMt0Ggp7fKV8Q__",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Request
Body
[
{
"id": "24bf4274-f25f-414c-b024-661e8bb04164",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "24bf4274-f25f-414c-b024-661e8bb04164",
"created_at": 1770151149.322767,
"updated_at": 1770151143.030549,
"deleted_at": 1770151143.030549,
"gallery": "60f20a3c-0140-11f1-a485-ceef6dd546fe",
"name": "Updated Name",
"order": 3,
"file": {
"id": "6a53fc6a-06d3-4582-a104-ca9a38e1f2ba",
"created_at": 1770151149.40931,
"updated_at": 1770151149.40931,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/641887e0-0140-11f1-bb7b-c1ce1696c2c7.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/641887e0-0140-11f1-bb7b-c1ce1696c2c7.png?Expires=1770237549412&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ToLdDkjtCLKUlp-6HM9b~TBTb40UdbKB~RdJFp2oi70mo4Ka-HHtEKW2A3T3k2EYewb90lZalxfqDDNP70Ces~hsSc4-wGvSTd8a2DkpBgXgZeydfBlmoCXxaM~MgtXFVareSogR2ErY5ChQ3pFW87hXGv~eYrTg6-nkzJVry4sZK8EFdUlM-0zZ0sqUsgdBY5AAHoweZGkOjEz5nK9pyuF-7fYMf8VDEEerj9ggn1Vc48pJNwah4j-pXMI5wX99aqJYMcC~czVyrzcLFLm6YSXWBZC2PWBby-IMo6Of2qNLZpkfvnFbPEbJuN3DxuSlqMKd2PEMIHMt0Ggp7fKV8Q__",
"preview_url": "https://private-cdn.irish.rechat.com/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/641887e0-0140-11f1-bb7b-c1ce1696c2c7.png?Expires=1770237549412&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ToLdDkjtCLKUlp-6HM9b~TBTb40UdbKB~RdJFp2oi70mo4Ka-HHtEKW2A3T3k2EYewb90lZalxfqDDNP70Ces~hsSc4-wGvSTd8a2DkpBgXgZeydfBlmoCXxaM~MgtXFVareSogR2ErY5ChQ3pFW87hXGv~eYrTg6-nkzJVry4sZK8EFdUlM-0zZ0sqUsgdBY5AAHoweZGkOjEz5nK9pyuF-7fYMf8VDEEerj9ggn1Vc48pJNwah4j-pXMI5wX99aqJYMcC~czVyrzcLFLm6YSXWBZC2PWBby-IMo6Of2qNLZpkfvnFbPEbJuN3DxuSlqMKd2PEMIHMt0Ggp7fKV8Q__",
"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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Request
Body
{
"items": [
"24bf4274-f25f-414c-b024-661e8bb04164"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/60f20a3c-0140-11f1-a485-ceef6dd546fe.zip?hash=jFzKqWRAR2CuyYeRRWMlVvwnhemAJAWLXStbf9tTLHPdA3FjHdTBveYbzSsUEyLgkxDSPuwS29FDCKVDtEbmgEfBX7kWJ5cSkh3puldnfF9wg5WxjiM9LFcybr1WdrfQEGPBAzRU3EZ2R6d7aAyiXWzN1co1pX6rFul6YC0RBVKFCeqzv8aof7YNuyS8gSaQ0jcYDDga5B6M1X1w5%2B4jqzYhsfdxFFhW82SdXBJtqi2bE7M%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: fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e
Response
200Body
{
"code": "OK",
"data": {
"id": "eef3dd30-378b-4b55-8737-0d4d8d9ce021",
"created_at": 1770151149.767595,
"updated_at": 1770151149.767595,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/644e64f0-0140-11f1-bb7b-c1ce1696c2c7.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/fc4de29b-a93a-4e7b-ab8c-e1cf895dd80e/644e64f0-0140-11f1-bb7b-c1ce1696c2c7.zip?Expires=1770237549770&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=AH7dtrNh5pHj3F2g7AszeyLioADfHKuL59AjpOSjO9odI5~Q1Z44I-h33h43fK2i1x8HyiUEXdZv3wKWleI9BqjU456r98rTRh6GpwfOlY2kEXqSWPnkvfAhAcjgFRyFW3KwBG-yyXRd7EFws9cpZ8xzInaZN-box0hXGJRncUaNCSGSgN76cBZWJI3Ch1c-LCfJTPXQQCNgGOkBdaso9lo4MYbJNxFK9NLaQRy1NLQoVDaeqhUmRwAbln1GfZL4H3rX2vDsUPfrplz0gKlyWvz~3Glf4Slqcw2T7iC2ndi-ncpqQOJbecgR314XurMncAeaH90zaMqCmPfiAcJZTQ__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}