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: 9c47a102-a038-427a-a8bb-0e912b7ac165
Response
200Body
{
"code": "OK",
"data": {
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-07-02T17:53:49.074Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "a9ef88e5-1ee1-4ec2-b767-189f9a931a4e",
"created_at": 1783014829.165256,
"updated_at": 1783014829.165256,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "SellerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bab91811-d0fe-4bdd-b017-67a681afcfda",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "de142d23-709d-4226-b903-73cf73f66065",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d1e8dd36-24aa-4b41-8a85-2ef0460e96ae",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ca7ac303-54c5-4ff4-9b85-3e4e216e0e87",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "310e1681-6581-44bd-b7b4-507eecdd501b",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "861d52a3-2aa7-4db4-8568-221051e099b6",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "2b3171a2-4cb6-4d28-a40c-646f97e7f8b2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "fb306b0b-c22b-4ee6-bad5-2ffb90c43aa3",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "76ae06d2-279c-4468-a785-df0a169a2eef",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "16d49b6f-174e-4e61-b6a4-c7d4398f4132",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "74a31401-3bb7-499e-8e86-b7c13d20659f",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "6819a3e4-8dbf-4ef5-a38e-d57abe1daada",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "217453b2-4f01-455e-95b8-b1359a41d32d",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d054c681-f556-408a-b0fc-c0a7debe0941",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bf5d6820-395e-464d-aa4c-ae40d8c0abc0",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "575700eb-ff1a-45fa-9dbf-17c76b2bb65e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "7a28d464-765c-4192-b12f-57254dcbf8f7",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "3a78044b-4a2d-43b3-b29c-b291c3108ed2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ac7c5daf-2204-4442-90c6-7312afa8aead",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "c654e4b9-7c0b-4127-8bb2-6aa27d5551a9",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "1543aee0-4fc7-4a6c-a70e-a82bf0ea0d38",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-07-02T17:53:49.074Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "a9ef88e5-1ee1-4ec2-b767-189f9a931a4e",
"created_at": 1783014829.165256,
"updated_at": 1783014829.165256,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "SellerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bab91811-d0fe-4bdd-b017-67a681afcfda",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "de142d23-709d-4226-b903-73cf73f66065",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d1e8dd36-24aa-4b41-8a85-2ef0460e96ae",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ca7ac303-54c5-4ff4-9b85-3e4e216e0e87",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "310e1681-6581-44bd-b7b4-507eecdd501b",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "861d52a3-2aa7-4db4-8568-221051e099b6",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "2b3171a2-4cb6-4d28-a40c-646f97e7f8b2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "fb306b0b-c22b-4ee6-bad5-2ffb90c43aa3",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "76ae06d2-279c-4468-a785-df0a169a2eef",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "16d49b6f-174e-4e61-b6a4-c7d4398f4132",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "74a31401-3bb7-499e-8e86-b7c13d20659f",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "6819a3e4-8dbf-4ef5-a38e-d57abe1daada",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "217453b2-4f01-455e-95b8-b1359a41d32d",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d054c681-f556-408a-b0fc-c0a7debe0941",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bf5d6820-395e-464d-aa4c-ae40d8c0abc0",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "575700eb-ff1a-45fa-9dbf-17c76b2bb65e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "7a28d464-765c-4192-b12f-57254dcbf8f7",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "3a78044b-4a2d-43b3-b29c-b291c3108ed2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ac7c5daf-2204-4442-90c6-7312afa8aead",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "c654e4b9-7c0b-4127-8bb2-6aa27d5551a9",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "1543aee0-4fc7-4a6c-a70e-a82bf0ea0d38",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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: 9edd8416-8eb2-4def-933a-d3907b17ddf4
Response
200Body
{
"code": "OK",
"data": [
{
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-07-02T17:53:49.074Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "a9ef88e5-1ee1-4ec2-b767-189f9a931a4e",
"created_at": 1783014829.165256,
"updated_at": 1783014829.165256,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "SellerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bab91811-d0fe-4bdd-b017-67a681afcfda",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "de142d23-709d-4226-b903-73cf73f66065",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d1e8dd36-24aa-4b41-8a85-2ef0460e96ae",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ca7ac303-54c5-4ff4-9b85-3e4e216e0e87",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "310e1681-6581-44bd-b7b4-507eecdd501b",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "861d52a3-2aa7-4db4-8568-221051e099b6",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "2b3171a2-4cb6-4d28-a40c-646f97e7f8b2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "fb306b0b-c22b-4ee6-bad5-2ffb90c43aa3",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "76ae06d2-279c-4468-a785-df0a169a2eef",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "16d49b6f-174e-4e61-b6a4-c7d4398f4132",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "74a31401-3bb7-499e-8e86-b7c13d20659f",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "6819a3e4-8dbf-4ef5-a38e-d57abe1daada",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "217453b2-4f01-455e-95b8-b1359a41d32d",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d054c681-f556-408a-b0fc-c0a7debe0941",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bf5d6820-395e-464d-aa4c-ae40d8c0abc0",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "575700eb-ff1a-45fa-9dbf-17c76b2bb65e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "7a28d464-765c-4192-b12f-57254dcbf8f7",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "3a78044b-4a2d-43b3-b29c-b291c3108ed2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ac7c5daf-2204-4442-90c6-7312afa8aead",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "c654e4b9-7c0b-4127-8bb2-6aa27d5551a9",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "1543aee0-4fc7-4a6c-a70e-a82bf0ea0d38",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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: 9edd8416-8eb2-4def-933a-d3907b17ddf4- associations
string(required) Example: deal.inboxes
Response
200Body
{
"code": "OK",
"data": [
{
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-07-02T17:53:49.074Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1783014833.042237,
"is_draft": false,
"roles": [
{
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "a9ef88e5-1ee1-4ec2-b767-189f9a931a4e",
"created_at": 1783014829.165256,
"updated_at": 1783014829.165256,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "SellerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bab91811-d0fe-4bdd-b017-67a681afcfda",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "de142d23-709d-4226-b903-73cf73f66065",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d1e8dd36-24aa-4b41-8a85-2ef0460e96ae",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ca7ac303-54c5-4ff4-9b85-3e4e216e0e87",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "310e1681-6581-44bd-b7b4-507eecdd501b",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "861d52a3-2aa7-4db4-8568-221051e099b6",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "2b3171a2-4cb6-4d28-a40c-646f97e7f8b2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "fb306b0b-c22b-4ee6-bad5-2ffb90c43aa3",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "76ae06d2-279c-4468-a785-df0a169a2eef",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "16d49b6f-174e-4e61-b6a4-c7d4398f4132",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "74a31401-3bb7-499e-8e86-b7c13d20659f",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "6819a3e4-8dbf-4ef5-a38e-d57abe1daada",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "217453b2-4f01-455e-95b8-b1359a41d32d",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d054c681-f556-408a-b0fc-c0a7debe0941",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bf5d6820-395e-464d-aa4c-ae40d8c0abc0",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "575700eb-ff1a-45fa-9dbf-17c76b2bb65e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "7a28d464-765c-4192-b12f-57254dcbf8f7",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "3a78044b-4a2d-43b3-b29c-b291c3108ed2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ac7c5daf-2204-4442-90c6-7312afa8aead",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "c654e4b9-7c0b-4127-8bb2-6aa27d5551a9",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "1543aee0-4fc7-4a6c-a70e-a82bf0ea0d38",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": [
{
"id": "4989ca91-0544-436c-95f9-73b11ebba906",
"brand": "b3d575d4-1095-4da9-bad5-0bb55d8062af",
"label": "Contract Inbox",
"created_by": null,
"listing_default": false,
"contract_default": true,
"created_at": 1783014828.070456,
"deleted_at": null,
"type": "deal_inbox"
}
],
"attention_requests": 1,
"has_active_offer": true,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-07-02T17:53:49.074Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "a9ef88e5-1ee1-4ec2-b767-189f9a931a4e",
"created_at": 1783014829.165256,
"updated_at": 1783014829.165256,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "SellerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bab91811-d0fe-4bdd-b017-67a681afcfda",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "de142d23-709d-4226-b903-73cf73f66065",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d1e8dd36-24aa-4b41-8a85-2ef0460e96ae",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ca7ac303-54c5-4ff4-9b85-3e4e216e0e87",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "310e1681-6581-44bd-b7b4-507eecdd501b",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "861d52a3-2aa7-4db4-8568-221051e099b6",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "2b3171a2-4cb6-4d28-a40c-646f97e7f8b2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "fb306b0b-c22b-4ee6-bad5-2ffb90c43aa3",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "76ae06d2-279c-4468-a785-df0a169a2eef",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "16d49b6f-174e-4e61-b6a4-c7d4398f4132",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "74a31401-3bb7-499e-8e86-b7c13d20659f",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "6819a3e4-8dbf-4ef5-a38e-d57abe1daada",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "217453b2-4f01-455e-95b8-b1359a41d32d",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d054c681-f556-408a-b0fc-c0a7debe0941",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bf5d6820-395e-464d-aa4c-ae40d8c0abc0",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "575700eb-ff1a-45fa-9dbf-17c76b2bb65e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "7a28d464-765c-4192-b12f-57254dcbf8f7",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "3a78044b-4a2d-43b3-b29c-b291c3108ed2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ac7c5daf-2204-4442-90c6-7312afa8aead",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "c654e4b9-7c0b-4127-8bb2-6aa27d5551a9",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "1543aee0-4fc7-4a6c-a70e-a82bf0ea0d38",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6"
}Response
200Body
{
"code": "OK",
"data": {
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"gallery": {
"id": "fa595eb4-763e-11f1-a9fa-76a72ce311da",
"created_at": 1783014828.540692,
"updated_at": 1783014828.540692,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"created_at": 1783014828.291724,
"updated_at": 1783014828.291724,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"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": "6839e19e-4334-4c0a-960a-431190221448",
"created_at": 1783014827.402416,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"checklist_type": "Selling",
"inbox": "72dffa34-5dd3-410f-8242-ab4c98afffbe",
"type": "brand_checklist",
"tasks": null
},
{
"id": "d32a2ee5-15e3-4bfe-b6b8-1f5657daa11b",
"created_at": 1783014827.402416,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"checklist_type": "Buying",
"inbox": "4989ca91-0544-436c-95f9-73b11ebba906",
"type": "brand_checklist",
"tasks": null
},
{
"id": "96164bec-7635-42a2-9d58-3e4532c4579b",
"created_at": 1783014827.402416,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"checklist_type": "Offer",
"inbox": "4989ca91-0544-436c-95f9-73b11ebba906",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": false,
"email": "[email protected]"
}
}Delete a deal ¶
Delete a dealDELETE/deals/:id
Example URI
DELETE /deals/:id
URI Parameters
- id
string(required) Example: 9c47a102-a038-427a-a8bb-0e912b7ac165
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: 9c47a102-a038-427a-a8bb-0e912b7ac165
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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "a9ef88e5-1ee1-4ec2-b767-189f9a931a4e",
"created_at": 1783014829.165256,
"updated_at": 1783014829.165256,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "SellerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165- rid
string(required) Example: d41c6433-6c25-4464-bc6f-bf021ca5d688
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688"
}Response
200Body
{
"code": "OK",
"data": {
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bab91811-d0fe-4bdd-b017-67a681afcfda",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "de142d23-709d-4226-b903-73cf73f66065",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d1e8dd36-24aa-4b41-8a85-2ef0460e96ae",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ca7ac303-54c5-4ff4-9b85-3e4e216e0e87",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "310e1681-6581-44bd-b7b4-507eecdd501b",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "861d52a3-2aa7-4db4-8568-221051e099b6",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "2b3171a2-4cb6-4d28-a40c-646f97e7f8b2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "fb306b0b-c22b-4ee6-bad5-2ffb90c43aa3",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "76ae06d2-279c-4468-a785-df0a169a2eef",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "16d49b6f-174e-4e61-b6a4-c7d4398f4132",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "74a31401-3bb7-499e-8e86-b7c13d20659f",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "6819a3e4-8dbf-4ef5-a38e-d57abe1daada",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "217453b2-4f01-455e-95b8-b1359a41d32d",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d054c681-f556-408a-b0fc-c0a7debe0941",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bf5d6820-395e-464d-aa4c-ae40d8c0abc0",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "575700eb-ff1a-45fa-9dbf-17c76b2bb65e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "7a28d464-765c-4192-b12f-57254dcbf8f7",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "3a78044b-4a2d-43b3-b29c-b291c3108ed2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ac7c5daf-2204-4442-90c6-7312afa8aead",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "c654e4b9-7c0b-4127-8bb2-6aa27d5551a9",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "1543aee0-4fc7-4a6c-a70e-a82bf0ea0d38",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6"
}Response
200Body
{
"code": "OK",
"data": {
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "5020 Junius Street",
"property_type": {
"id": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"created_at": 1783014828.291724,
"updated_at": 1783014828.291724,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"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": "6839e19e-4334-4c0a-960a-431190221448",
"created_at": 1783014827.402416,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"checklist_type": "Selling",
"inbox": "72dffa34-5dd3-410f-8242-ab4c98afffbe",
"type": "brand_checklist",
"tasks": null
},
{
"id": "d32a2ee5-15e3-4bfe-b6b8-1f5657daa11b",
"created_at": 1783014827.402416,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"checklist_type": "Buying",
"inbox": "4989ca91-0544-436c-95f9-73b11ebba906",
"type": "brand_checklist",
"tasks": null
},
{
"id": "96164bec-7635-42a2-9d58-3e4532c4579b",
"created_at": 1783014827.402416,
"deleted_at": null,
"brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6",
"checklist_type": "Offer",
"inbox": "4989ca91-0544-436c-95f9-73b11ebba906",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bab91811-d0fe-4bdd-b017-67a681afcfda",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "de142d23-709d-4226-b903-73cf73f66065",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d1e8dd36-24aa-4b41-8a85-2ef0460e96ae",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ca7ac303-54c5-4ff4-9b85-3e4e216e0e87",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "310e1681-6581-44bd-b7b4-507eecdd501b",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "861d52a3-2aa7-4db4-8568-221051e099b6",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "2b3171a2-4cb6-4d28-a40c-646f97e7f8b2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "fb306b0b-c22b-4ee6-bad5-2ffb90c43aa3",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "76ae06d2-279c-4468-a785-df0a169a2eef",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "16d49b6f-174e-4e61-b6a4-c7d4398f4132",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "74a31401-3bb7-499e-8e86-b7c13d20659f",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "6819a3e4-8dbf-4ef5-a38e-d57abe1daada",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "217453b2-4f01-455e-95b8-b1359a41d32d",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "d054c681-f556-408a-b0fc-c0a7debe0941",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "bf5d6820-395e-464d-aa4c-ae40d8c0abc0",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "575700eb-ff1a-45fa-9dbf-17c76b2bb65e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "7a28d464-765c-4192-b12f-57254dcbf8f7",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "3a78044b-4a2d-43b3-b29c-b291c3108ed2",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "ac7c5daf-2204-4442-90c6-7312afa8aead",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "c654e4b9-7c0b-4127-8bb2-6aa27d5551a9",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "MLS",
"definition": "1543aee0-4fc7-4a6c-a70e-a82bf0ea0d38",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165
Request
Body
{
"context": [
{
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"value": "2017/12/06"
},
{
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165- cid
string(required) Example: 698c4910-a9cc-4b99-b128-541c23d884ce
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_at": 1783014828.540551,
"updated_at": 1783014828.540551,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "f70cc459-c034-4c24-bea5-226995b6c5a2",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "b1eb2f29-a05f-487c-b31a-9479a511fe0e",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": null,
"source": "PropertyType",
"definition": "bc6fbc05-2f0d-43c4-aa2c-a49c104542a1",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": "2026-07-02T17:53:47.402416+00:00",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"approved_at": "2026-07-02T17:53:48.852881+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"source": "Provided",
"definition": "f6160d26-d474-431d-ae27-d693497b384e",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "698c4910-a9cc-4b99-b128-541c23d884ce",
"type": "deal_context_item",
"created_at": 1783014827.402416,
"approved_at": 1783014828.852881,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96"
}
],
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165
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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "d41c6433-6c25-4464-bc6f-bf021ca5d688",
"created_at": 1783014829.161651,
"updated_at": 1783014829.161651,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "BuyerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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": "a9ef88e5-1ee1-4ec2-b767-189f9a931a4e",
"created_at": 1783014829.165256,
"updated_at": 1783014829.165256,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"role": "SellerAgent",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"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": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"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": false,
"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",
"bio": null,
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165- rid
string(required) Example: d41c6433-6c25-4464-bc6f-bf021ca5d688
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: 9c47a102-a038-427a-a8bb-0e912b7ac165
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "16d5e5fc-c37d-4ca2-8978-2d23111a9dc6"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"created_at": 1783014827.402416,
"updated_at": 1783014827.402416,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"order": 1,
"origin": "96164bec-7635-42a2-9d58-3e4532c4579b",
"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",
"inbox": "4989ca91-0544-436c-95f9-73b11ebba906",
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165- cid
string(required) Example: 0d9d68a7-d4b0-4082-801b-cc1f1966ec96
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96"
}Response
200Body
{
"code": "OK",
"data": {
"id": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"created_at": 1783014827.402416,
"updated_at": 1783014827.402416,
"deleted_at": null,
"deactivated_at": "2026-07-02T17:53:53.434Z",
"title": "Updated Checklist 1",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"order": 3,
"origin": "96164bec-7635-42a2-9d58-3e4532c4579b",
"terminated_at": "2026-07-02T17:53:53.434Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47",
"created_at": 1783014829.834463,
"updated_at": 1783014833.29868,
"room": {
"type": "room",
"id": "f0a4d6b3-2b01-448f-84ee-0b09ae948481",
"title": "5020 Junius Street: Test Title",
"created_at": 1783014829.823432,
"updated_at": 1783014833.00344,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "f82a664d-a38c-4b85-be28-53a26d175eb6",
"last_revision": "13a66294-4be7-41a6-af04-a6b5d76ac649",
"state": "Fair",
"created_at": 1783014831.683559,
"updated_at": 1783014832.130419,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"formstack_id": null,
"author": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "dc0c3f0e-3e3c-41fd-bd6a-ccc41ed38dc6",
"created_at": 1783014832.150568,
"updated_at": 1783014832.150568,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf?Expires=1783101232153&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=AbETA7zCTvpdrVF9PP2R7r1YEFcRtz~g0cjUTeCnuStWnkWbuOw2yYlEHmDLkFssrrf~Nz-ExcfxZAt301pU0414B4Ox6OL8n75lgY9nxz-~5TD85b42enHnpgG6GquzUv23jfxZWA9kGqVPL5pXWzoZV4pMMX1DRZgT89NCQTY7wrSTA61RaCXCTriLzbFgnPCC9gtJbCB3jwsGMPRteE0sGhisUWEdL6flHtm6ZALMG7ndTsuig607hAJoA2OZ4Y6cGgBqik5QUGZ2ux5GGSXcNRpTOneVGxqqrSwSGcba8n9mElG~m51r7n~br3zbRXXBOWLiTJ5aWePIBpM6NQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "6ce5cf46-2b67-4556-add8-b873665b00cb",
"created_at": 1783014832.57921,
"type": "review",
"status": "Declined",
"updated_at": 1783014832.583513
},
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/submission.pdf?hash=jFzZqXtHACj139nWRGYiBvVrhuyUJRmLDz4LY4VWYybEXyF6GNOTuuQcyCoXB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXihAuxye0IATg%3D%3D"
}
],
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"inbox": "4989ca91-0544-436c-95f9-73b11ebba906",
"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: 4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47
Response
200Body
{
"code": "OK",
"data": {
"id": "4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47",
"created_at": 1783014829.834463,
"updated_at": 1783014831.726038,
"room": {
"type": "room",
"id": "f0a4d6b3-2b01-448f-84ee-0b09ae948481",
"title": "5020 Junius Street: Test Title",
"created_at": 1783014829.823432,
"updated_at": 1783014832.346618,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "f82a664d-a38c-4b85-be28-53a26d175eb6",
"last_revision": "13a66294-4be7-41a6-af04-a6b5d76ac649",
"state": "Fair",
"created_at": 1783014831.683559,
"updated_at": 1783014832.130419,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"formstack_id": null,
"author": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "dc0c3f0e-3e3c-41fd-bd6a-ccc41ed38dc6",
"created_at": 1783014832.150568,
"updated_at": 1783014832.150568,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf?Expires=1783101232153&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=AbETA7zCTvpdrVF9PP2R7r1YEFcRtz~g0cjUTeCnuStWnkWbuOw2yYlEHmDLkFssrrf~Nz-ExcfxZAt301pU0414B4Ox6OL8n75lgY9nxz-~5TD85b42enHnpgG6GquzUv23jfxZWA9kGqVPL5pXWzoZV4pMMX1DRZgT89NCQTY7wrSTA61RaCXCTriLzbFgnPCC9gtJbCB3jwsGMPRteE0sGhisUWEdL6flHtm6ZALMG7ndTsuig607hAJoA2OZ4Y6cGgBqik5QUGZ2ux5GGSXcNRpTOneVGxqqrSwSGcba8n9mElG~m51r7n~br3zbRXXBOWLiTJ5aWePIBpM6NQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/submission.pdf?hash=jFzZqXtHACj139nWRGYiBvVrhuyUJRmLDz4LY4VWYybEXyF6GNOTuuQcyCoXB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXigAuxzf0IATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: 9c47a102-a038-427a-a8bb-0e912b7ac165
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"is_deletable": true,
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"room": "f0a4d6b3-2b01-448f-84ee-0b09ae948481"
}Response
200Body
{
"code": "OK",
"data": {
"id": "4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47",
"created_at": 1783014829.834463,
"updated_at": 1783014829.834463,
"room": {
"type": "room",
"id": "f0a4d6b3-2b01-448f-84ee-0b09ae948481",
"title": "5020 Junius Street: Test Title",
"created_at": 1783014829.823432,
"updated_at": 1783014829.903657,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/submission.pdf?hash=jFzZqXtHACj139nWRGYiBvVrhuyUJRmLDz4LY4VWYybEXyF6GNOTuuQcyCoXB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXiiAulzdkIATg%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: 4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47
Request
Body
{
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"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": "f82a664d-a38c-4b85-be28-53a26d175eb6",
"last_revision": "62382090-ab5d-4d43-bef1-5b42f7abf173",
"state": "Fair",
"created_at": 1783014831.683559,
"updated_at": 1783014831.88848,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"formstack_id": null,
"author": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "8bf9134a-7989-4252-a7b9-a82a15e920c4",
"created_at": 1783014831.911357,
"updated_at": 1783014831.911357,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc58bd40-763e-11f1-94b5-7519f45a456b.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc58bd40-763e-11f1-94b5-7519f45a456b.pdf?Expires=1783101231914&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ccL1bwwVulXPf8Q1QiQ7F1lSReo92JaNBKelGrhdQRbakrHlPKDhGhNOQomk9cGKvDR75sSQnqU-d9DpuBDefJ~7Gy93yHtgcgiLNTpw41aqqSQyABZ5D68x5FpDbRrAYSl7XX63YSjjsfKjiD-TSNCgYYo4XekVA8kEiaJxvxPrMPOJjswfn02LvAg-8YnKUKZG5I2X9tdiBTy~SSazVXQxBZQIxjNguxWWUD9LZpcO64iS-dw9pWJmXvTjZxuqCAL2kUVCO4wvJrGsideBB4SPqfzKWgqALAfP4wNAQ~z9uBQAYdymkiak1ADfno5iTAheX1iVPi28QdVaYl6wqw__",
"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: 4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47- revision
string(required) Example: 62382090-ab5d-4d43-bef1-5b42f7abf173
Response
200Body
{
"code": "OK",
"data": {
"id": "62382090-ab5d-4d43-bef1-5b42f7abf173",
"submission": "f82a664d-a38c-4b85-be28-53a26d175eb6",
"created_at": 1783014831.683559,
"updated_at": 1783014831.88848,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"author": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "8bf9134a-7989-4252-a7b9-a82a15e920c4"
}
}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: 4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47
Request
Body
{
"status": "Declined",
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9"
}Response
200Body
{
"code": "OK",
"data": {
"id": "4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47",
"created_at": 1783014829.834463,
"updated_at": 1783014832.59141,
"room": {
"type": "room",
"id": "f0a4d6b3-2b01-448f-84ee-0b09ae948481",
"title": "5020 Junius Street: Test Title",
"created_at": 1783014829.823432,
"updated_at": 1783014832.622923,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "f82a664d-a38c-4b85-be28-53a26d175eb6",
"last_revision": "13a66294-4be7-41a6-af04-a6b5d76ac649",
"state": "Fair",
"created_at": 1783014831.683559,
"updated_at": 1783014832.130419,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"formstack_id": null,
"author": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "dc0c3f0e-3e3c-41fd-bd6a-ccc41ed38dc6",
"created_at": 1783014832.150568,
"updated_at": 1783014832.150568,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf?Expires=1783101232153&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=AbETA7zCTvpdrVF9PP2R7r1YEFcRtz~g0cjUTeCnuStWnkWbuOw2yYlEHmDLkFssrrf~Nz-ExcfxZAt301pU0414B4Ox6OL8n75lgY9nxz-~5TD85b42enHnpgG6GquzUv23jfxZWA9kGqVPL5pXWzoZV4pMMX1DRZgT89NCQTY7wrSTA61RaCXCTriLzbFgnPCC9gtJbCB3jwsGMPRteE0sGhisUWEdL6flHtm6ZALMG7ndTsuig607hAJoA2OZ4Y6cGgBqik5QUGZ2ux5GGSXcNRpTOneVGxqqrSwSGcba8n9mElG~m51r7n~br3zbRXXBOWLiTJ5aWePIBpM6NQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "6ce5cf46-2b67-4556-add8-b873665b00cb",
"created_at": 1783014832.57921,
"type": "review",
"status": "Declined",
"updated_at": 1783014832.583513
},
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/submission.pdf?hash=jFzZqXtHACj139nWRGYiBvVrhuyUJRmLDz4LY4VWYybEXyF6GNOTuuQcyCoXB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXigAu5yeEIATg%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: 4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47",
"created_at": 1783014829.834463,
"updated_at": 1783014833.042237,
"room": {
"type": "room",
"id": "f0a4d6b3-2b01-448f-84ee-0b09ae948481",
"title": "5020 Junius Street: Test Title",
"created_at": 1783014829.823432,
"updated_at": 1783014833.00344,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "f82a664d-a38c-4b85-be28-53a26d175eb6",
"last_revision": "13a66294-4be7-41a6-af04-a6b5d76ac649",
"state": "Fair",
"created_at": 1783014831.683559,
"updated_at": 1783014832.130419,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"formstack_id": null,
"author": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "dc0c3f0e-3e3c-41fd-bd6a-ccc41ed38dc6",
"created_at": 1783014832.150568,
"updated_at": 1783014832.150568,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc7daa60-763e-11f1-94b5-7519f45a456b.pdf?Expires=1783101232153&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=AbETA7zCTvpdrVF9PP2R7r1YEFcRtz~g0cjUTeCnuStWnkWbuOw2yYlEHmDLkFssrrf~Nz-ExcfxZAt301pU0414B4Ox6OL8n75lgY9nxz-~5TD85b42enHnpgG6GquzUv23jfxZWA9kGqVPL5pXWzoZV4pMMX1DRZgT89NCQTY7wrSTA61RaCXCTriLzbFgnPCC9gtJbCB3jwsGMPRteE0sGhisUWEdL6flHtm6ZALMG7ndTsuig607hAJoA2OZ4Y6cGgBqik5QUGZ2ux5GGSXcNRpTOneVGxqqrSwSGcba8n9mElG~m51r7n~br3zbRXXBOWLiTJ5aWePIBpM6NQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "6ce5cf46-2b67-4556-add8-b873665b00cb",
"created_at": 1783014832.57921,
"type": "review",
"status": "Declined",
"updated_at": 1783014832.583513
},
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-07-02T17:53:53.042Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/submission.pdf?hash=jFzZqXtHACj139nWRGYiBvVrhuyUJRmLDz4LY4VWYybEXyF6GNOTuuQcyCoXB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXihAul6fkIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: bf59ece2-df46-4e4c-bf59-244b5b2d9f40
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "bf59ece2-df46-4e4c-bf59-244b5b2d9f40",
"created_at": 1783014830.0694,
"updated_at": 1783014830.551658,
"room": {
"type": "room",
"id": "6d95a401-110d-48d5-8823-09730a53ecbd",
"title": "5020 Junius Street: Another Task",
"created_at": 1783014830.05921,
"updated_at": 1783014830.136567,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/bf59ece2-df46-4e4c-bf59-244b5b2d9f40/submission.pdf?hash=jFzZqXtHACj1iduGSjYgAf5r0uyZIhmLCDIJY98ENCvECXB6HITG6bRGzyoQB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXiiAux6ekIATg%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: 9c47a102-a038-427a-a8bb-0e912b7ac165
Request
Body
[
{
"id": "4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47",
"title": "Bulk Test Title"
},
{
"id": "bf59ece2-df46-4e4c-bf59-244b5b2d9f40",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47",
"created_at": 1783014829.834463,
"updated_at": 1783014830.662363,
"room": {
"type": "room",
"id": "f0a4d6b3-2b01-448f-84ee-0b09ae948481",
"title": "5020 Junius Street: Test Title",
"created_at": 1783014829.823432,
"updated_at": 1783014830.422505,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"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": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/submission.pdf?hash=jFzZqXtHACj139nWRGYiBvVrhuyUJRmLDz4LY4VWYybEXyF6GNOTuuQcyCoXB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXiiAuF3d0IATg%3D%3D"
},
{
"id": "bf59ece2-df46-4e4c-bf59-244b5b2d9f40",
"created_at": 1783014830.0694,
"updated_at": 1783014830.759665,
"room": {
"type": "room",
"id": "6d95a401-110d-48d5-8823-09730a53ecbd",
"title": "5020 Junius Street: Another Task",
"created_at": 1783014830.05921,
"updated_at": 1783014830.715634,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"c6069838-8b31-4026-8e90-9bbfca2fd2d9": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "e9f08385-2efa-4f79-a189-c568c8e072aa",
"checklist": "0d9d68a7-d4b0-4082-801b-cc1f1966ec96",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-07-02T17:53:50.759Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "9c47a102-a038-427a-a8bb-0e912b7ac165",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/bf59ece2-df46-4e4c-bf59-244b5b2d9f40/submission.pdf?hash=jFzZqXtHACj1iduGSjYgAf5r0uyZIhmLCDIJY98ENCvECXB6HITG6bRGzyoQB2inxE%2BVOb1Ni5BPGqtK7Ufsmh2RQboCcpcNlQG06EM1Z1UkzJbmjiY6eF0zZqoeYPGdRmKCTXNE1lZyWqV6aAyiJG3Ju802pXiiAuF3d0IATg%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: 4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "8bf9134a-7989-4252-a7b9-a82a15e920c4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "435915ea-7703-43be-8afd-181205c54cb6",
"reference": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"reference_type": "User",
"created_at": 1783014832.328842,
"updated_at": 1783014832.328842,
"deleted_at": null,
"object": {
"id": "8bf9134a-7989-4252-a7b9-a82a15e920c4",
"created_at": 1783014831.911357,
"updated_at": 1783014831.911357,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc58bd40-763e-11f1-94b5-7519f45a456b.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47/fc58bd40-763e-11f1-94b5-7519f45a456b.pdf?Expires=1783101231914&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=ccL1bwwVulXPf8Q1QiQ7F1lSReo92JaNBKelGrhdQRbakrHlPKDhGhNOQomk9cGKvDR75sSQnqU-d9DpuBDefJ~7Gy93yHtgcgiLNTpw41aqqSQyABZ5D68x5FpDbRrAYSl7XX63YSjjsfKjiD-TSNCgYYo4XekVA8kEiaJxvxPrMPOJjswfn02LvAg-8YnKUKZG5I2X9tdiBTy~SSazVXQxBZQIxjNguxWWUD9LZpcO64iS-dw9pWJmXvTjZxuqCAL2kUVCO4wvJrGsideBB4SPqfzKWgqALAfP4wNAQ~z9uBQAYdymkiak1ADfno5iTAheX1iVPi28QdVaYl6wqw__",
"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: 4de75ab9-0f91-4b8a-84b4-de4fb7a4ca47
Request
Body
{
"comment": "Comment",
"author": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"room": "f0a4d6b3-2b01-448f-84ee-0b09ae948481"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "2d328da7-90ad-4dee-bd1d-ab1cb1f89432",
"id": "2d328da7-90ad-4dee-bd1d-ab1cb1f89432",
"comment": "Comment",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+15658148473",
"created_at": 1783014827.419689,
"id": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1783014827.402416,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "950c30f9-ced8-4954-a4df-7bd582075378",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "12:53 PM - Thursday Jul 02, 2026",
"push_allowed": true,
"agents": [
{
"id": "2fd19b11-6817-4c02-a9b8-94bb659a3956",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "1071285421",
"updated_at": 1783014827.602214,
"deleted_at": null,
"created_at": 1783014827.602214,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "9edd8416-8eb2-4def-933a-d3907b17ddf4",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1783014833.607373,
"updated_at": 1783014833.607373,
"room": "f0a4d6b3-2b01-448f-84ee-0b09ae948481",
"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,
"artifacts": 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: bf59ece2-df46-4e4c-bf59-244b5b2d9f40
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: 9c47a102-a038-427a-a8bb-0e912b7ac165
Response
200Body
{
"code": "OK",
"data": {
"id": "6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c",
"created_at": 1783014834.107434,
"updated_at": 1783014834.107434,
"deleted_at": null,
"gallery": "fa595eb4-763e-11f1-a9fa-76a72ce311da",
"name": null,
"order": 0,
"file": {
"id": "f8ac87ba-5ab2-467a-a566-b346dcd74873",
"created_at": 1783014834.102378,
"updated_at": 1783014834.102378,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "9c47a102-a038-427a-a8bb-0e912b7ac165/fda98030-763e-11f1-94b5-7519f45a456b.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/9c47a102-a038-427a-a8bb-0e912b7ac165/fda98030-763e-11f1-94b5-7519f45a456b.png",
"preview_url": "https://test.cloudfront.net/9c47a102-a038-427a-a8bb-0e912b7ac165/fda98030-763e-11f1-94b5-7519f45a456b.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: 9c47a102-a038-427a-a8bb-0e912b7ac165- iid
string(required) Example: 6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "f8ac87ba-5ab2-467a-a566-b346dcd74873"
}Response
200Body
{
"code": "OK",
"data": {
"id": "6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c",
"created_at": 1783014834.107434,
"updated_at": 1783014827.402416,
"deleted_at": null,
"gallery": "fa595eb4-763e-11f1-a9fa-76a72ce311da",
"name": "Updated Name",
"order": 2,
"file": {
"id": "f8ac87ba-5ab2-467a-a566-b346dcd74873",
"created_at": 1783014834.102378,
"updated_at": 1783014834.102378,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "9c47a102-a038-427a-a8bb-0e912b7ac165/fda98030-763e-11f1-94b5-7519f45a456b.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/9c47a102-a038-427a-a8bb-0e912b7ac165/fda98030-763e-11f1-94b5-7519f45a456b.png",
"preview_url": "https://test.cloudfront.net/9c47a102-a038-427a-a8bb-0e912b7ac165/fda98030-763e-11f1-94b5-7519f45a456b.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: 9c47a102-a038-427a-a8bb-0e912b7ac165- iid
string(required) Example: 6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c
Response
200Body
{
"code": "OK",
"data": {
"id": "6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c",
"created_at": 1783014834.107434,
"updated_at": 1783014827.402416,
"deleted_at": null,
"gallery": "fa595eb4-763e-11f1-a9fa-76a72ce311da",
"name": "Updated Name",
"order": 2,
"file": {
"id": "06b02606-c7ea-4b49-afdd-1c11df52c419",
"created_at": 1783014834.19681,
"updated_at": 1783014834.19681,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "9c47a102-a038-427a-a8bb-0e912b7ac165/fdb7ff20-763e-11f1-94b5-7519f45a456b.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/9c47a102-a038-427a-a8bb-0e912b7ac165/fdb7ff20-763e-11f1-94b5-7519f45a456b.png?Expires=1783101234200&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=e7VSQLZOL1yoAHEx1lrBRF8pfrSOMMFMxcURxBL6R5Z1aZ59umGAof~SLLvOA1aRtFYXRZUj7TQNPoK0f3kQlLaA3gozko-~CTnSfwqhX2Sq5IpZQmuenSHNFvMRR99P9JrJIOJ-6sp8Dqf637bttepc2r2m972rArcsFVk8bKuJuaOnL-xYrx0qOGgaoH4T~4LkHsbrY9eFAy7u6GG8QP9rb9FnX8NK3Ox~xReppOFKlCP8W1TO7Opsb4uDKDfRIwhTpsI32yivSfnXgK~nSGSCaOtSRWWy0obk505zElcVdSZRxFFpmLF17LniyicmLMMmy6vmH5sslAkl7H0NLQ__",
"preview_url": "https://private-cdn.irish.rechat.com/9c47a102-a038-427a-a8bb-0e912b7ac165/fdb7ff20-763e-11f1-94b5-7519f45a456b.png?Expires=1783101234200&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=e7VSQLZOL1yoAHEx1lrBRF8pfrSOMMFMxcURxBL6R5Z1aZ59umGAof~SLLvOA1aRtFYXRZUj7TQNPoK0f3kQlLaA3gozko-~CTnSfwqhX2Sq5IpZQmuenSHNFvMRR99P9JrJIOJ-6sp8Dqf637bttepc2r2m972rArcsFVk8bKuJuaOnL-xYrx0qOGgaoH4T~4LkHsbrY9eFAy7u6GG8QP9rb9FnX8NK3Ox~xReppOFKlCP8W1TO7Opsb4uDKDfRIwhTpsI32yivSfnXgK~nSGSCaOtSRWWy0obk505zElcVdSZRxFFpmLF17LniyicmLMMmy6vmH5sslAkl7H0NLQ__",
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165
Request
Body
[
{
"id": "6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c",
"created_at": 1783014834.107434,
"updated_at": 1783014827.402416,
"deleted_at": 1783014827.402416,
"gallery": "fa595eb4-763e-11f1-a9fa-76a72ce311da",
"name": "Updated Name",
"order": 3,
"file": {
"id": "06b02606-c7ea-4b49-afdd-1c11df52c419",
"created_at": 1783014834.19681,
"updated_at": 1783014834.19681,
"deleted_at": null,
"created_by": "c6069838-8b31-4026-8e90-9bbfca2fd2d9",
"path": "9c47a102-a038-427a-a8bb-0e912b7ac165/fdb7ff20-763e-11f1-94b5-7519f45a456b.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/9c47a102-a038-427a-a8bb-0e912b7ac165/fdb7ff20-763e-11f1-94b5-7519f45a456b.png?Expires=1783101234200&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=e7VSQLZOL1yoAHEx1lrBRF8pfrSOMMFMxcURxBL6R5Z1aZ59umGAof~SLLvOA1aRtFYXRZUj7TQNPoK0f3kQlLaA3gozko-~CTnSfwqhX2Sq5IpZQmuenSHNFvMRR99P9JrJIOJ-6sp8Dqf637bttepc2r2m972rArcsFVk8bKuJuaOnL-xYrx0qOGgaoH4T~4LkHsbrY9eFAy7u6GG8QP9rb9FnX8NK3Ox~xReppOFKlCP8W1TO7Opsb4uDKDfRIwhTpsI32yivSfnXgK~nSGSCaOtSRWWy0obk505zElcVdSZRxFFpmLF17LniyicmLMMmy6vmH5sslAkl7H0NLQ__",
"preview_url": "https://private-cdn.irish.rechat.com/9c47a102-a038-427a-a8bb-0e912b7ac165/fdb7ff20-763e-11f1-94b5-7519f45a456b.png?Expires=1783101234200&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=e7VSQLZOL1yoAHEx1lrBRF8pfrSOMMFMxcURxBL6R5Z1aZ59umGAof~SLLvOA1aRtFYXRZUj7TQNPoK0f3kQlLaA3gozko-~CTnSfwqhX2Sq5IpZQmuenSHNFvMRR99P9JrJIOJ-6sp8Dqf637bttepc2r2m972rArcsFVk8bKuJuaOnL-xYrx0qOGgaoH4T~4LkHsbrY9eFAy7u6GG8QP9rb9FnX8NK3Ox~xReppOFKlCP8W1TO7Opsb4uDKDfRIwhTpsI32yivSfnXgK~nSGSCaOtSRWWy0obk505zElcVdSZRxFFpmLF17LniyicmLMMmy6vmH5sslAkl7H0NLQ__",
"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: 9c47a102-a038-427a-a8bb-0e912b7ac165
Request
Body
{
"items": [
"6eb29dd7-78bd-49fd-ae3b-82f35f8bc61c"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/fa595eb4-763e-11f1-a9fa-76a72ce311da.zip?hash=jFzKqWRAR2CuyYeRFTJ2Xfkj1L6AIwKMCCtbf9tTLHPQXSVjSYfF7OIczC0RFCDkkxDSPuwS29FDCP5F5ULtjxbLX7NNdZYSlxy%2Bu1c9L1V2g8nnjXI%2FfV0xO7pWe7fQEGPBAzRU3EZ2R6d7aAynXWzM1ckypXihFux3YCsXBFKFCeqzv8aof7YNuyS40CbE32FLDzhL7kmO1X14tekjqGMg5%2Fd%2FEA8A%2FmDHDkVqrXqbE7M%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: 9c47a102-a038-427a-a8bb-0e912b7ac165
Response
200Body
{
"code": "OK",
"data": {
"id": "9b7322ba-0b83-472f-b31e-f92affbf1cef",
"created_at": 1783014834.691232,
"updated_at": 1783014834.691232,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/9c47a102-a038-427a-a8bb-0e912b7ac165/fe01d960-763e-11f1-94b5-7519f45a456b.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/9c47a102-a038-427a-a8bb-0e912b7ac165/fe01d960-763e-11f1-94b5-7519f45a456b.zip?Expires=1783101234695&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=QSgmSKFvk8fweipjOmu833tRarc7x38cJCviLIN4Kd1XQ8Sc0c0ws217NAZlW6G~srqIYaLddOr36A6QK73uqZ1S2VX6jRM51D38kbhU3a~8XrjwAH6IKuMq~K4LJuTIfKRplccHji72J9OYbat7Uqn7ow~zbwi1LNRUubKAoHrlXv-BJRLYwZMiEbQDAK0Y7Fm7mTO1yS~FUOgtC4ZJKK~pmdwnQ4wPctcIQx5vYWkLGqQaEbedmNFCrD-7ZYJPjF1dALOEGNkTRGKCClTHdFnP4W1Vf0vk86d1mcai-1vuDI-GzGG3G4hZWZMyVNl6HxObRb6vqzZGiSd9rI7e7w__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}