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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Response
200Body
{
"code": "OK",
"data": {
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-05-15T19:09:12.645Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "ccea20bc-bf12-46fc-98b9-13436c61bb80",
"created_at": 1778872152.752198,
"updated_at": 1778872152.752198,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "4b4c7634-22e2-439d-907d-d7fde6ac9d33",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "ad877c3f-e000-40c8-a5b7-13b0aa6bd960",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d3fc9179-43f9-4fe2-9bae-07c03b5d03ab",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cf113bdb-12e9-4df7-82a7-8c3e8c1eb6b4",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d7737621-a9a9-4ef3-9bf8-96dd846836b9",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "df9213da-67cc-44fa-9dad-1d617053a562",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "b378ca83-1a00-43ca-9c30-31c9fae902ae",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "932d9f90-c40b-4620-97a3-8a170912d4ad",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "806ed10c-23bf-414c-bfe0-a0be3df8e94f",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "bcceb77f-f831-4156-85fc-da9b196cf61e",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "fdda9168-991e-4ef7-b789-ea4f2b4d162a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "9b580e2f-2a5b-4fc1-843a-b37bef0bec63",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "3a3ea325-9069-4b9a-80b8-1a82d6317e96",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "c8b298ce-ab4b-4a03-b5c7-252b107b6bc5",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "69ed71cd-1a00-4dfb-8ff0-843289bef546",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "054c9471-6cfc-46f2-930f-db083c5a2b17",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "6fa247be-e4c7-47a6-9f41-284779599402",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cc72e24c-fead-4bfc-8b66-60a1481abc8a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "eed5c06a-af89-414a-824d-4bb1a3f44fb7",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "2bb087b1-dc0c-40da-a2cf-e1e2cb4bb15d",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "05f755c2-7f2a-47c6-bd84-16ac26dfd44b",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
}Get deals created by a user ¶
Get deals created by a userGET/deals
This endpoint is marked for deprecation on 2026-01-01.
Example URI
GET /deals
Response
200Body
{
"code": "OK",
"data": [
{
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-05-15T19:09:12.645Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "ccea20bc-bf12-46fc-98b9-13436c61bb80",
"created_at": 1778872152.752198,
"updated_at": 1778872152.752198,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "4b4c7634-22e2-439d-907d-d7fde6ac9d33",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "ad877c3f-e000-40c8-a5b7-13b0aa6bd960",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d3fc9179-43f9-4fe2-9bae-07c03b5d03ab",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cf113bdb-12e9-4df7-82a7-8c3e8c1eb6b4",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d7737621-a9a9-4ef3-9bf8-96dd846836b9",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "df9213da-67cc-44fa-9dad-1d617053a562",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "b378ca83-1a00-43ca-9c30-31c9fae902ae",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "932d9f90-c40b-4620-97a3-8a170912d4ad",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "806ed10c-23bf-414c-bfe0-a0be3df8e94f",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "bcceb77f-f831-4156-85fc-da9b196cf61e",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "fdda9168-991e-4ef7-b789-ea4f2b4d162a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "9b580e2f-2a5b-4fc1-843a-b37bef0bec63",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "3a3ea325-9069-4b9a-80b8-1a82d6317e96",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "c8b298ce-ab4b-4a03-b5c7-252b107b6bc5",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "69ed71cd-1a00-4dfb-8ff0-843289bef546",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "054c9471-6cfc-46f2-930f-db083c5a2b17",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "6fa247be-e4c7-47a6-9f41-284779599402",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cc72e24c-fead-4bfc-8b66-60a1481abc8a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "eed5c06a-af89-414a-824d-4bb1a3f44fb7",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "2bb087b1-dc0c-40da-a2cf-e1e2cb4bb15d",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "05f755c2-7f2a-47c6-bd84-16ac26dfd44b",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 0
}
}Get all deals belonging to a brand ¶
Get all deals belonging to a brandGET/brands/:brand/deals
Example URI
GET /brands/:brand/deals
URI Parameters
- brand
string(required) Example: fa7dd701-cc45-4f99-be79-7a587ec23663
Response
200Body
{
"code": "OK",
"data": [
{
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-05-15T19:09:12.645Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "ccea20bc-bf12-46fc-98b9-13436c61bb80",
"created_at": 1778872152.752198,
"updated_at": 1778872152.752198,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "4b4c7634-22e2-439d-907d-d7fde6ac9d33",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "ad877c3f-e000-40c8-a5b7-13b0aa6bd960",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d3fc9179-43f9-4fe2-9bae-07c03b5d03ab",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cf113bdb-12e9-4df7-82a7-8c3e8c1eb6b4",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d7737621-a9a9-4ef3-9bf8-96dd846836b9",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "df9213da-67cc-44fa-9dad-1d617053a562",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "b378ca83-1a00-43ca-9c30-31c9fae902ae",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "932d9f90-c40b-4620-97a3-8a170912d4ad",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "806ed10c-23bf-414c-bfe0-a0be3df8e94f",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "bcceb77f-f831-4156-85fc-da9b196cf61e",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "fdda9168-991e-4ef7-b789-ea4f2b4d162a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "9b580e2f-2a5b-4fc1-843a-b37bef0bec63",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "3a3ea325-9069-4b9a-80b8-1a82d6317e96",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "c8b298ce-ab4b-4a03-b5c7-252b107b6bc5",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "69ed71cd-1a00-4dfb-8ff0-843289bef546",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "054c9471-6cfc-46f2-930f-db083c5a2b17",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "6fa247be-e4c7-47a6-9f41-284779599402",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cc72e24c-fead-4bfc-8b66-60a1481abc8a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "eed5c06a-af89-414a-824d-4bb1a3f44fb7",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "2bb087b1-dc0c-40da-a2cf-e1e2cb4bb15d",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "05f755c2-7f2a-47c6-bd84-16ac26dfd44b",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 2
}
}Get all deals that need backoffice review ¶
Get all deals that need backoffice reviewGET/brands/:brand/deals/inbox
Example URI
GET /brands/:brand/deals/inbox
URI Parameters
- brand
string(required) Example: fa7dd701-cc45-4f99-be79-7a587ec23663
Response
200Body
{
"code": "OK",
"data": [
{
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-05-15T19:09:12.645Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1778872157.73386,
"is_draft": false,
"roles": [
{
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "ccea20bc-bf12-46fc-98b9-13436c61bb80",
"created_at": 1778872152.752198,
"updated_at": 1778872152.752198,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "4b4c7634-22e2-439d-907d-d7fde6ac9d33",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "ad877c3f-e000-40c8-a5b7-13b0aa6bd960",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d3fc9179-43f9-4fe2-9bae-07c03b5d03ab",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cf113bdb-12e9-4df7-82a7-8c3e8c1eb6b4",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d7737621-a9a9-4ef3-9bf8-96dd846836b9",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "df9213da-67cc-44fa-9dad-1d617053a562",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "b378ca83-1a00-43ca-9c30-31c9fae902ae",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "932d9f90-c40b-4620-97a3-8a170912d4ad",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "806ed10c-23bf-414c-bfe0-a0be3df8e94f",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "bcceb77f-f831-4156-85fc-da9b196cf61e",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "fdda9168-991e-4ef7-b789-ea4f2b4d162a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "9b580e2f-2a5b-4fc1-843a-b37bef0bec63",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "3a3ea325-9069-4b9a-80b8-1a82d6317e96",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "c8b298ce-ab4b-4a03-b5c7-252b107b6bc5",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "69ed71cd-1a00-4dfb-8ff0-843289bef546",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "054c9471-6cfc-46f2-930f-db083c5a2b17",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "6fa247be-e4c7-47a6-9f41-284779599402",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cc72e24c-fead-4bfc-8b66-60a1481abc8a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "eed5c06a-af89-414a-824d-4bb1a3f44fb7",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "2bb087b1-dc0c-40da-a2cf-e1e2cb4bb15d",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "05f755c2-7f2a-47c6-bd84-16ac26dfd44b",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": [
"Contract"
],
"attention_requests": 1,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 0
}
}Search through all deals ¶
Search through all dealsPOST/deals/filter
Sort object looks like the following:
{
$order: {
direction, // DESC or ASC
field, // Used for some of the base properties of the deal like deal.title, deal.created_at, deal.faired_at, deal.property_type
context: { // Used for sorting based on dynamic deal contexts.
type, // Type of field you are applying the sorting to. either `number` or `date`
fields: [] // Array of names of contexts. like ['sales_price', 'list_price']
}
}
}Example URI
POST /deals/filter
Request
Body
{
"query": "5020 Junius Street",
"$order": {
"field": "deals.updated_at",
"direction": "DESC"
},
"limit": 100,
"start": 0
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": "2026-05-15T19:09:12.645Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "ccea20bc-bf12-46fc-98b9-13436c61bb80",
"created_at": 1778872152.752198,
"updated_at": 1778872152.752198,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "4b4c7634-22e2-439d-907d-d7fde6ac9d33",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "ad877c3f-e000-40c8-a5b7-13b0aa6bd960",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d3fc9179-43f9-4fe2-9bae-07c03b5d03ab",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cf113bdb-12e9-4df7-82a7-8c3e8c1eb6b4",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d7737621-a9a9-4ef3-9bf8-96dd846836b9",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "df9213da-67cc-44fa-9dad-1d617053a562",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "b378ca83-1a00-43ca-9c30-31c9fae902ae",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "932d9f90-c40b-4620-97a3-8a170912d4ad",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "806ed10c-23bf-414c-bfe0-a0be3df8e94f",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "bcceb77f-f831-4156-85fc-da9b196cf61e",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "fdda9168-991e-4ef7-b789-ea4f2b4d162a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "9b580e2f-2a5b-4fc1-843a-b37bef0bec63",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "3a3ea325-9069-4b9a-80b8-1a82d6317e96",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "c8b298ce-ab4b-4a03-b5c7-252b107b6bc5",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "69ed71cd-1a00-4dfb-8ff0-843289bef546",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "054c9471-6cfc-46f2-930f-db083c5a2b17",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "6fa247be-e4c7-47a6-9f41-284779599402",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cc72e24c-fead-4bfc-8b66-60a1481abc8a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "eed5c06a-af89-414a-824d-4bb1a3f44fb7",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "2bb087b1-dc0c-40da-a2cf-e1e2cb4bb15d",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "05f755c2-7f2a-47c6-bd84-16ac26dfd44b",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 1
}
}Create a deal with a listing ¶
Create a deal with a listingPOST/deals
Example URI
POST /deals
URI Parameters
- associations
string(required) Example: deal.gallery,deal.property_type,brand_property_type.checklists
Request
Body
{
"deal_type": "Buying",
"is_draft": true,
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44"
}Response
200Body
{
"code": "OK",
"data": {
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "[Draft]",
"gallery": {
"id": "8eba1310-5091-11f1-9f3b-a6e2379790b9",
"created_at": 1778872152.02353,
"updated_at": 1778872152.02353,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "822d332e-4206-4392-8599-28fdd39b3e44",
"created_at": 1778872151.698228,
"updated_at": 1778872151.698228,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "a49a5ac6-be7d-4020-8f42-85742d389d81",
"created_at": 1778872150.464763,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "6c27315a-5f9c-446f-b2c4-917732090d79",
"created_at": 1778872150.464763,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "18b0de3d-c02b-40ab-82f7-4cf9372e0b9b",
"created_at": 1778872150.464763,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44",
"checklist_type": "Offer",
"type": "brand_checklist",
"tasks": null
}
]
},
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"property_type": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "property_type",
"text": "Residential Lease",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": false,
"array_agg": null,
"email": "[email protected]"
}
}Delete a deal ¶
Delete a dealDELETE/deals/:id
Example URI
DELETE /deals/:id
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "ccea20bc-bf12-46fc-98b9-13436c61bb80",
"created_at": 1778872152.752198,
"updated_at": 1778872152.752198,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- rid
string(required) Example: 7909e0b8-53d6-4bfd-b79e-976eff5a26e4
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "4b4c7634-22e2-439d-907d-d7fde6ac9d33",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "ad877c3f-e000-40c8-a5b7-13b0aa6bd960",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d3fc9179-43f9-4fe2-9bae-07c03b5d03ab",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cf113bdb-12e9-4df7-82a7-8c3e8c1eb6b4",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d7737621-a9a9-4ef3-9bf8-96dd846836b9",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "df9213da-67cc-44fa-9dad-1d617053a562",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "b378ca83-1a00-43ca-9c30-31c9fae902ae",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "932d9f90-c40b-4620-97a3-8a170912d4ad",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "806ed10c-23bf-414c-bfe0-a0be3df8e94f",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "bcceb77f-f831-4156-85fc-da9b196cf61e",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "fdda9168-991e-4ef7-b789-ea4f2b4d162a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "9b580e2f-2a5b-4fc1-843a-b37bef0bec63",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "3a3ea325-9069-4b9a-80b8-1a82d6317e96",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "c8b298ce-ab4b-4a03-b5c7-252b107b6bc5",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "69ed71cd-1a00-4dfb-8ff0-843289bef546",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "054c9471-6cfc-46f2-930f-db083c5a2b17",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "6fa247be-e4c7-47a6-9f41-284779599402",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cc72e24c-fead-4bfc-8b66-60a1481abc8a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "eed5c06a-af89-414a-824d-4bb1a3f44fb7",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "2bb087b1-dc0c-40da-a2cf-e1e2cb4bb15d",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "05f755c2-7f2a-47c6-bd84-16ac26dfd44b",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
}Change property type of a deal ¶
Change property type of a dealPATCH/deals/:id/property_type
Example URI
PATCH /deals/:id/property_type
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44"
}Response
200Body
{
"code": "OK",
"data": {
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "5020 Junius Street",
"property_type": {
"id": "822d332e-4206-4392-8599-28fdd39b3e44",
"created_at": 1778872151.698228,
"updated_at": 1778872151.698228,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "a49a5ac6-be7d-4020-8f42-85742d389d81",
"created_at": 1778872150.464763,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": "Listing Inbox",
"is_deactivatable": false,
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44",
"checklist_type": "Selling",
"type": "brand_checklist",
"tasks": null
},
{
"id": "6c27315a-5f9c-446f-b2c4-917732090d79",
"created_at": 1778872150.464763,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": "Contract Inbox",
"is_deactivatable": false,
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44",
"checklist_type": "Buying",
"type": "brand_checklist",
"tasks": null
},
{
"id": "18b0de3d-c02b-40ab-82f7-4cf9372e0b9b",
"created_at": 1778872150.464763,
"deleted_at": null,
"brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": "Contract",
"is_deactivatable": true,
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44",
"checklist_type": "Offer",
"type": "brand_checklist",
"tasks": null
}
]
},
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "4b4c7634-22e2-439d-907d-d7fde6ac9d33",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "ad877c3f-e000-40c8-a5b7-13b0aa6bd960",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d3fc9179-43f9-4fe2-9bae-07c03b5d03ab",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cf113bdb-12e9-4df7-82a7-8c3e8c1eb6b4",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "d7737621-a9a9-4ef3-9bf8-96dd846836b9",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "df9213da-67cc-44fa-9dad-1d617053a562",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "b378ca83-1a00-43ca-9c30-31c9fae902ae",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "932d9f90-c40b-4620-97a3-8a170912d4ad",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "806ed10c-23bf-414c-bfe0-a0be3df8e94f",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "bcceb77f-f831-4156-85fc-da9b196cf61e",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "fdda9168-991e-4ef7-b789-ea4f2b4d162a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "9b580e2f-2a5b-4fc1-843a-b37bef0bec63",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "3a3ea325-9069-4b9a-80b8-1a82d6317e96",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "c8b298ce-ab4b-4a03-b5c7-252b107b6bc5",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "69ed71cd-1a00-4dfb-8ff0-843289bef546",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "054c9471-6cfc-46f2-930f-db083c5a2b17",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "6fa247be-e4c7-47a6-9f41-284779599402",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "cc72e24c-fead-4bfc-8b66-60a1481abc8a",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "eed5c06a-af89-414a-824d-4bb1a3f44fb7",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "2bb087b1-dc0c-40da-a2cf-e1e2cb4bb15d",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "MLS",
"definition": "05f755c2-7f2a-47c6-bd84-16ac26dfd44b",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
}Add Context to a deal ¶
Add Context to a dealPOST/deals/:id/context
Example URI
POST /deals/:id/context
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Request
Body
{
"context": [
{
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"value": "2017/12/06"
},
{
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
}Set approval status for a context ¶
Set approval status for a contextPATCH/deals/:id/context/:cid/approved
Example URI
PATCH /deals/:id/context/:cid/approved
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- cid
string(required) Example: 6f9ea888-4328-425d-b581-31972989680a
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_at": 1778872152.023425,
"updated_at": 1778872152.023425,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 7,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "651fceef-5bb8-4e65-926b-3bdce0edf112",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "9c844eb0-3797-4b7c-bd63-902642e83f08",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": null,
"source": "PropertyType",
"definition": "eabc5ba6-3af5-4487-bcc7-ac16c4703743",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": "2026-05-15T19:09:10.464763+00:00",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"approved_at": "2026-05-15T19:09:12.357301+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"source": "Provided",
"definition": "d370a18b-7fc6-4562-a85d-28e401d27c85",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": null,
"attention_requests": 0,
"has_active_offer": true,
"array_agg": null,
"email": "[email protected]"
}
}Get history for a deal context on a deal ¶
Get history for a deal context on a dealGET/deals/:id/context/:cname
Example URI
GET /deals/:id/context/:cname
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "6f9ea888-4328-425d-b581-31972989680a",
"type": "deal_context_item",
"created_at": 1778872150.464763,
"approved_at": 1778872152.357301,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39"
}
],
"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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "7909e0b8-53d6-4bfd-b79e-976eff5a26e4",
"created_at": 1778872152.745068,
"updated_at": 1778872152.745069,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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": "ccea20bc-bf12-46fc-98b9-13436c61bb80",
"created_at": 1778872152.752198,
"updated_at": 1778872152.752198,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"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": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- rid
string(required) Example: 7909e0b8-53d6-4bfd-b79e-976eff5a26e4
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "822d332e-4206-4392-8599-28fdd39b3e44"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"created_at": 1778872150.464763,
"updated_at": 1778872150.464763,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"order": 1,
"origin": "18b0de3d-c02b-40ab-82f7-4cf9372e0b9b",
"terminated_at": null,
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": false,
"is_terminated": false,
"tasks": null,
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"tab_name": "Contract",
"is_active_offer": true
}
}Update a checklist ¶
Update a checklistPUT/deals/:id/checklists/:cid
Example URI
PUT /deals/:id/checklists/:cid
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- cid
string(required) Example: a78fce4c-01a4-472c-8fb2-6d737f0fea39
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "a78fce4c-01a4-472c-8fb2-6d737f0fea39"
}Response
200Body
{
"code": "OK",
"data": {
"id": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"created_at": 1778872150.464763,
"updated_at": 1778872150.464763,
"deleted_at": null,
"deactivated_at": "2026-05-15T19:09:18.161Z",
"title": "Updated Checklist 1",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"order": 3,
"origin": "18b0de3d-c02b-40ab-82f7-4cf9372e0b9b",
"terminated_at": "2026-05-15T19:09:18.161Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "33b59261-5785-4eb6-bee1-297f3ddaebcf",
"created_at": 1778872153.598219,
"updated_at": 1778872158.029505,
"room": {
"type": "room",
"id": "e11165f3-5d56-40ce-80a4-a0a301206f35",
"title": "5020 Junius Street: Test Title",
"created_at": 1778872153.581939,
"updated_at": 1778872157.681296,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "091d0024-ba16-4683-9192-74791deeb7c3",
"last_revision": "46273243-f6ac-4c8f-af8b-903ec8010192",
"state": "Fair",
"created_at": 1778872156.164449,
"updated_at": 1778872156.695345,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "0e497a98-0d4a-4993-b6e2-dff02a1d426a",
"created_at": 1778872156.729451,
"updated_at": 1778872156.729451,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf?Expires=1778958556733&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=R0nNv3PfF1QdeRDHUjwYHUHx5Z-d4FuQPQ44IlY1nOv-D0TOmrBy10N4B0Sz3Cmtteho5pVvk955vCG25sBlRUnnn8ZczGQrLJ3aOeWhv~uDVjAiCA2CNSEN-s1B0DkJOLenBaFeyQn7XSeupFctT~8Fgj6YV-DvH6hx4z~i~4IxxGSAQgcrkJK2oOewK7F7feVrt~hzyvbMUTRxfQMwDZIQ0F2s9-bqQjyDESKId3-ow~yujIQgeEgriFhOG-ZWAAr7pAn1q9G22sCtLw8YgD~yvO5-JMljP7bedvfgnV7uL~nGmGSRHlubpRBeHJEmqL23QlPthNw79uSmpX92Eg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "42e61d1c-9627-401d-934d-f2ecd9d38ebd",
"created_at": 1778872157.15043,
"type": "review",
"status": "Declined",
"updated_at": 1778872157.158291
},
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/submission.pdf?hash=jFzZqXtHACj12I7RRmpxUv1rg72VIRmLCGRcY98HZCPECX15GILAv7Eay31GB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXyqAutwfEIATg%3D%3D"
}
],
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"tab_name": "Contract",
"is_active_offer": false
}
}Get a single task ¶
Get a single taskGET/tasks/:id
Example URI
GET /tasks/:id
URI Parameters
- task
string(required) Example: 33b59261-5785-4eb6-bee1-297f3ddaebcf
Response
200Body
{
"code": "OK",
"data": {
"id": "33b59261-5785-4eb6-bee1-297f3ddaebcf",
"created_at": 1778872153.598219,
"updated_at": 1778872156.227877,
"room": {
"type": "room",
"id": "e11165f3-5d56-40ce-80a4-a0a301206f35",
"title": "5020 Junius Street: Test Title",
"created_at": 1778872153.581939,
"updated_at": 1778872156.924755,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "091d0024-ba16-4683-9192-74791deeb7c3",
"last_revision": "46273243-f6ac-4c8f-af8b-903ec8010192",
"state": "Fair",
"created_at": 1778872156.164449,
"updated_at": 1778872156.695345,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "0e497a98-0d4a-4993-b6e2-dff02a1d426a",
"created_at": 1778872156.729451,
"updated_at": 1778872156.729451,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf?Expires=1778958556733&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=R0nNv3PfF1QdeRDHUjwYHUHx5Z-d4FuQPQ44IlY1nOv-D0TOmrBy10N4B0Sz3Cmtteho5pVvk955vCG25sBlRUnnn8ZczGQrLJ3aOeWhv~uDVjAiCA2CNSEN-s1B0DkJOLenBaFeyQn7XSeupFctT~8Fgj6YV-DvH6hx4z~i~4IxxGSAQgcrkJK2oOewK7F7feVrt~hzyvbMUTRxfQMwDZIQ0F2s9-bqQjyDESKId3-ow~yujIQgeEgriFhOG-ZWAAr7pAn1q9G22sCtLw8YgD~yvO5-JMljP7bedvfgnV7uL~nGmGSRHlubpRBeHJEmqL23QlPthNw79uSmpX92Eg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/submission.pdf?hash=jFzZqXtHACj12I7RRmpxUv1rg72VIRmLCGRcY98HZCPECX15GILAv7Eay31GB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXylAul0e0IATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"is_deletable": true,
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "e11165f3-5d56-40ce-80a4-a0a301206f35"
}Response
200Body
{
"code": "OK",
"data": {
"id": "33b59261-5785-4eb6-bee1-297f3ddaebcf",
"created_at": 1778872153.598219,
"updated_at": 1778872153.598219,
"room": {
"type": "room",
"id": "e11165f3-5d56-40ce-80a4-a0a301206f35",
"title": "5020 Junius Street: Test Title",
"created_at": 1778872153.581939,
"updated_at": 1778872153.695298,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/submission.pdf?hash=jFzZqXtHACj12I7RRmpxUv1rg72VIRmLCGRcY98HZCPECX15GILAv7Eay31GB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXyhAuB0eEIATg%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: 33b59261-5785-4eb6-bee1-297f3ddaebcf
Request
Body
{
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"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": "091d0024-ba16-4683-9192-74791deeb7c3",
"last_revision": "2ddb534a-a54a-4368-bbb3-ed2a8e548527",
"state": "Fair",
"created_at": 1778872156.164449,
"updated_at": 1778872156.422426,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "ff3e5b36-5f23-4bd2-9486-2f083adc309d",
"created_at": 1778872156.444438,
"updated_at": 1778872156.444438,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9159fdb0-5091-11f1-8248-cf8ab660e2ca.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9159fdb0-5091-11f1-8248-cf8ab660e2ca.pdf?Expires=1778958556448&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=XGBuTPoP9ddKpe4YABfPsetT5sfCKCzGioYxMWlyLYPYB4vK3DAiwbPsvecDvvXDyye9DcjHS7QoS93~vM56dPscHpDgfgYKJdWqVcHMvQnUL-sT7qXguSx~~0Oa4RFCL2i8nv85U7eFEYMcETsdMihnRCIimySqIIoSmM4YVgLzTzmCIGGWUNdfLv2fhquAVX9qNkdcau~2KwOl2GeSZ-AoX4TxvIILIUUjtS1i4333zNKDVV5VeXwXt0kYZpikzNUMo3xv~pm5GcsbsYQkoEglvJn4kvk8XZE3zam0z1gV2Kar12i64nb0pXX9qyj1mxN6FskzLkrJs5L8XJnUSg__",
"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: 33b59261-5785-4eb6-bee1-297f3ddaebcf- revision
string(required) Example: 2ddb534a-a54a-4368-bbb3-ed2a8e548527
Response
200Body
{
"code": "OK",
"data": {
"id": "2ddb534a-a54a-4368-bbb3-ed2a8e548527",
"submission": "091d0024-ba16-4683-9192-74791deeb7c3",
"created_at": 1778872156.164449,
"updated_at": 1778872156.422426,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "ff3e5b36-5f23-4bd2-9486-2f083adc309d"
}
}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: 33b59261-5785-4eb6-bee1-297f3ddaebcf
Request
Body
{
"status": "Declined",
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "33b59261-5785-4eb6-bee1-297f3ddaebcf",
"created_at": 1778872153.598219,
"updated_at": 1778872157.182386,
"room": {
"type": "room",
"id": "e11165f3-5d56-40ce-80a4-a0a301206f35",
"title": "5020 Junius Street: Test Title",
"created_at": 1778872153.581939,
"updated_at": 1778872157.218626,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "091d0024-ba16-4683-9192-74791deeb7c3",
"last_revision": "46273243-f6ac-4c8f-af8b-903ec8010192",
"state": "Fair",
"created_at": 1778872156.164449,
"updated_at": 1778872156.695345,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "0e497a98-0d4a-4993-b6e2-dff02a1d426a",
"created_at": 1778872156.729451,
"updated_at": 1778872156.729451,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf?Expires=1778958556733&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=R0nNv3PfF1QdeRDHUjwYHUHx5Z-d4FuQPQ44IlY1nOv-D0TOmrBy10N4B0Sz3Cmtteho5pVvk955vCG25sBlRUnnn8ZczGQrLJ3aOeWhv~uDVjAiCA2CNSEN-s1B0DkJOLenBaFeyQn7XSeupFctT~8Fgj6YV-DvH6hx4z~i~4IxxGSAQgcrkJK2oOewK7F7feVrt~hzyvbMUTRxfQMwDZIQ0F2s9-bqQjyDESKId3-ow~yujIQgeEgriFhOG-ZWAAr7pAn1q9G22sCtLw8YgD~yvO5-JMljP7bedvfgnV7uL~nGmGSRHlubpRBeHJEmqL23QlPthNw79uSmpX92Eg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "42e61d1c-9627-401d-934d-f2ecd9d38ebd",
"created_at": 1778872157.15043,
"type": "review",
"status": "Declined",
"updated_at": 1778872157.158291
},
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/submission.pdf?hash=jFzZqXtHACj12I7RRmpxUv1rg72VIRmLCGRcY98HZCPECX15GILAv7Eay31GB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXylAupweEIATg%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: 33b59261-5785-4eb6-bee1-297f3ddaebcf
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "33b59261-5785-4eb6-bee1-297f3ddaebcf",
"created_at": 1778872153.598219,
"updated_at": 1778872157.73386,
"room": {
"type": "room",
"id": "e11165f3-5d56-40ce-80a4-a0a301206f35",
"title": "5020 Junius Street: Test Title",
"created_at": 1778872153.581939,
"updated_at": 1778872157.681296,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "091d0024-ba16-4683-9192-74791deeb7c3",
"last_revision": "46273243-f6ac-4c8f-af8b-903ec8010192",
"state": "Fair",
"created_at": 1778872156.164449,
"updated_at": 1778872156.695345,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"formstack_id": null,
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "0e497a98-0d4a-4993-b6e2-dff02a1d426a",
"created_at": 1778872156.729451,
"updated_at": 1778872156.729451,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9183f3e0-5091-11f1-8248-cf8ab660e2ca.pdf?Expires=1778958556733&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=R0nNv3PfF1QdeRDHUjwYHUHx5Z-d4FuQPQ44IlY1nOv-D0TOmrBy10N4B0Sz3Cmtteho5pVvk955vCG25sBlRUnnn8ZczGQrLJ3aOeWhv~uDVjAiCA2CNSEN-s1B0DkJOLenBaFeyQn7XSeupFctT~8Fgj6YV-DvH6hx4z~i~4IxxGSAQgcrkJK2oOewK7F7feVrt~hzyvbMUTRxfQMwDZIQ0F2s9-bqQjyDESKId3-ow~yujIQgeEgriFhOG-ZWAAr7pAn1q9G22sCtLw8YgD~yvO5-JMljP7bedvfgnV7uL~nGmGSRHlubpRBeHJEmqL23QlPthNw79uSmpX92Eg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "42e61d1c-9627-401d-934d-f2ecd9d38ebd",
"created_at": 1778872157.15043,
"type": "review",
"status": "Declined",
"updated_at": 1778872157.158291
},
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-05-15T19:09:17.733Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/submission.pdf?hash=jFzZqXtHACj12I7RRmpxUv1rg72VIRmLCGRcY98HZCPECX15GILAv7Eay31GB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXylAuFyf0IATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: c1f7db54-fe11-4dd1-b651-7b8b6e95a892
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "c1f7db54-fe11-4dd1-b651-7b8b6e95a892",
"created_at": 1778872154.064292,
"updated_at": 1778872154.734217,
"room": {
"type": "room",
"id": "7281fa08-4eea-4145-835b-acff64d1cdf8",
"title": "5020 Junius Street: Another Task",
"created_at": 1778872154.050734,
"updated_at": 1778872154.158439,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/c1f7db54-fe11-4dd1-b651-7b8b6e95a892/submission.pdf?hash=jFzZqXtHACj1iIzVRDchUfhr0O%2BcJRmLCWJbY99UNCPEDCZ2HIfB4uUekScSB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXymAuFzfUIATg%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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Request
Body
[
{
"id": "33b59261-5785-4eb6-bee1-297f3ddaebcf",
"title": "Bulk Test Title"
},
{
"id": "c1f7db54-fe11-4dd1-b651-7b8b6e95a892",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "33b59261-5785-4eb6-bee1-297f3ddaebcf",
"created_at": 1778872153.598219,
"updated_at": 1778872154.888771,
"room": {
"type": "room",
"id": "e11165f3-5d56-40ce-80a4-a0a301206f35",
"title": "5020 Junius Street: Test Title",
"created_at": 1778872153.581939,
"updated_at": 1778872154.54749,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"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": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/submission.pdf?hash=jFzZqXtHACj12I7RRmpxUv1rg72VIRmLCGRcY98HZCPECX15GILAv7Eay31GB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXynAul0eEIATg%3D%3D"
},
{
"id": "c1f7db54-fe11-4dd1-b651-7b8b6e95a892",
"created_at": 1778872154.064292,
"updated_at": 1778872154.9993,
"room": {
"type": "room",
"id": "7281fa08-4eea-4145-835b-acff64d1cdf8",
"title": "5020 Junius Street: Another Task",
"created_at": 1778872154.050734,
"updated_at": 1778872154.943099,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"80a227b2-29a0-11e7-b636-e4a7a08e15d4": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "Unit"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "65a8e098-0474-436e-8bd9-37e7db656225",
"checklist": "a78fce4c-01a4-472c-8fb2-6d737f0fea39",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-05-15T19:09:14.999Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "26b2cf7a-ca8c-4857-98ee-dd68954feac1",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/c1f7db54-fe11-4dd1-b651-7b8b6e95a892/submission.pdf?hash=jFzZqXtHACj1iIzVRDchUfhr0O%2BcJRmLCWJbY99UNCPEDCZ2HIfB4uUekScSB2inxE%2BVOb1Ni8tJS69B4hbmmhfKE7sCd5ZalAHuu0kzZwlyz8fk3yw5LVoza6oeYPGdRmKCTXNE1lZyWqV4aA2lJG3Hu8g8pXynAul0eEIATg%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: 33b59261-5785-4eb6-bee1-297f3ddaebcf
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "ff3e5b36-5f23-4bd2-9486-2f083adc309d"
}Response
200Body
{
"code": "OK",
"data": {
"id": "f0158c0e-b8a6-43ae-8d5c-7e2a19ef6345",
"reference": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"reference_type": "User",
"created_at": 1778872156.908222,
"updated_at": 1778872156.908222,
"deleted_at": null,
"object": {
"id": "ff3e5b36-5f23-4bd2-9486-2f083adc309d",
"created_at": 1778872156.444438,
"updated_at": 1778872156.444438,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9159fdb0-5091-11f1-8248-cf8ab660e2ca.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/33b59261-5785-4eb6-bee1-297f3ddaebcf/9159fdb0-5091-11f1-8248-cf8ab660e2ca.pdf?Expires=1778958556448&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=XGBuTPoP9ddKpe4YABfPsetT5sfCKCzGioYxMWlyLYPYB4vK3DAiwbPsvecDvvXDyye9DcjHS7QoS93~vM56dPscHpDgfgYKJdWqVcHMvQnUL-sT7qXguSx~~0Oa4RFCL2i8nv85U7eFEYMcETsdMihnRCIimySqIIoSmM4YVgLzTzmCIGGWUNdfLv2fhquAVX9qNkdcau~2KwOl2GeSZ-AoX4TxvIILIUUjtS1i4333zNKDVV5VeXwXt0kYZpikzNUMo3xv~pm5GcsbsYQkoEglvJn4kvk8XZE3zam0z1gV2Kar12i64nb0pXX9qyj1mxN6FskzLkrJs5L8XJnUSg__",
"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: 33b59261-5785-4eb6-bee1-297f3ddaebcf
Request
Body
{
"comment": "Comment",
"author": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"room": "e11165f3-5d56-40ce-80a4-a0a301206f35"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "d8cd49b9-8610-45a0-b6e0-0a98fd305419",
"id": "d8cd49b9-8610-45a0-b6e0-0a98fd305419",
"comment": "Comment",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1778872150.464763,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"current_time": "2:09 PM - Friday May 15, 2026",
"push_allowed": true,
"agents": [
{
"id": "060bfc9e-bf5e-40db-8243-8cbb937f8292",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1778872150.601467,
"deleted_at": null,
"created_at": 1778872150.601467,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "fa7dd701-cc45-4f99-be79-7a587ec23663",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"created_at": 1778872158.311378,
"updated_at": 1778872158.311378,
"room": "e11165f3-5d56-40ce-80a4-a0a301206f35",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": null,
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
}
}Delete a task ¶
Delete a taskDELETE/tasks/:task
Example URI
DELETE /tasks/:task
URI Parameters
- task
string(required) Example: c1f7db54-fe11-4dd1-b651-7b8b6e95a892
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Response
200Body
{
"code": "OK",
"data": {
"id": "5d8ac210-701f-4e18-b3eb-c533f8ac45d7",
"created_at": 1778872158.966076,
"updated_at": 1778872158.966076,
"deleted_at": null,
"gallery": "8eba1310-5091-11f1-9f3b-a6e2379790b9",
"name": null,
"order": 0,
"file": {
"id": "cb46709c-19ef-4830-b00d-ccdcd86ef403",
"created_at": 1778872158.959434,
"updated_at": 1778872158.959434,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "26b2cf7a-ca8c-4857-98ee-dd68954feac1/92dbe2c0-5091-11f1-8248-cf8ab660e2ca.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92dbe2c0-5091-11f1-8248-cf8ab660e2ca.png",
"preview_url": "https://test.cloudfront.net/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92dbe2c0-5091-11f1-8248-cf8ab660e2ca.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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- iid
string(required) Example: 5d8ac210-701f-4e18-b3eb-c533f8ac45d7
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "cb46709c-19ef-4830-b00d-ccdcd86ef403"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5d8ac210-701f-4e18-b3eb-c533f8ac45d7",
"created_at": 1778872158.966076,
"updated_at": 1778872150.464763,
"deleted_at": null,
"gallery": "8eba1310-5091-11f1-9f3b-a6e2379790b9",
"name": "Updated Name",
"order": 2,
"file": {
"id": "cb46709c-19ef-4830-b00d-ccdcd86ef403",
"created_at": 1778872158.959434,
"updated_at": 1778872158.959434,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "26b2cf7a-ca8c-4857-98ee-dd68954feac1/92dbe2c0-5091-11f1-8248-cf8ab660e2ca.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92dbe2c0-5091-11f1-8248-cf8ab660e2ca.png",
"preview_url": "https://test.cloudfront.net/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92dbe2c0-5091-11f1-8248-cf8ab660e2ca.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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1- iid
string(required) Example: 5d8ac210-701f-4e18-b3eb-c533f8ac45d7
Response
200Body
{
"code": "OK",
"data": {
"id": "5d8ac210-701f-4e18-b3eb-c533f8ac45d7",
"created_at": 1778872158.966076,
"updated_at": 1778872150.464763,
"deleted_at": null,
"gallery": "8eba1310-5091-11f1-9f3b-a6e2379790b9",
"name": "Updated Name",
"order": 2,
"file": {
"id": "45e99e1d-f4da-441c-a3fe-f4f15abdfb5d",
"created_at": 1778872159.0741,
"updated_at": 1778872159.0741,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "26b2cf7a-ca8c-4857-98ee-dd68954feac1/92ed20d0-5091-11f1-8248-cf8ab660e2ca.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92ed20d0-5091-11f1-8248-cf8ab660e2ca.png?Expires=1778958559080&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=OIbJ69AUiijccgUsLs8N8KsXuBbGIpmwOpk2Xn3rLAFFB-4vkYAkp5YAvmMgHdV0y6TPH6vgr6NnGn5qR9tYGW4gF6Y96cgdZHOFjInE6qVesl5ZDPXfUzsegzVyZEA7qG4z2RP0ty2BiKGS21tgy2nAmnR3RsOhcvnsAaX8ELiWj7uWPzHQQGPmsR6q7IXRsr~uZfw9bW7HVlnaXuF54j~9sw~jFqeknT1EOPURyfke-eXgJXIOBRSk4tn7Vm2xpH5y2E2eieOvm4SXVLbHsiX~OcKR1sPt3fBTbUCjNAa9HXNnEJVEseanGmsCXIPlFmJNVVcCDp62SvqXmYPCNg__",
"preview_url": "https://private-cdn.irish.rechat.com/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92ed20d0-5091-11f1-8248-cf8ab660e2ca.png?Expires=1778958559080&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=OIbJ69AUiijccgUsLs8N8KsXuBbGIpmwOpk2Xn3rLAFFB-4vkYAkp5YAvmMgHdV0y6TPH6vgr6NnGn5qR9tYGW4gF6Y96cgdZHOFjInE6qVesl5ZDPXfUzsegzVyZEA7qG4z2RP0ty2BiKGS21tgy2nAmnR3RsOhcvnsAaX8ELiWj7uWPzHQQGPmsR6q7IXRsr~uZfw9bW7HVlnaXuF54j~9sw~jFqeknT1EOPURyfke-eXgJXIOBRSk4tn7Vm2xpH5y2E2eieOvm4SXVLbHsiX~OcKR1sPt3fBTbUCjNAa9HXNnEJVEseanGmsCXIPlFmJNVVcCDp62SvqXmYPCNg__",
"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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Request
Body
[
{
"id": "5d8ac210-701f-4e18-b3eb-c533f8ac45d7",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "5d8ac210-701f-4e18-b3eb-c533f8ac45d7",
"created_at": 1778872158.966076,
"updated_at": 1778872150.464763,
"deleted_at": 1778872150.464763,
"gallery": "8eba1310-5091-11f1-9f3b-a6e2379790b9",
"name": "Updated Name",
"order": 3,
"file": {
"id": "45e99e1d-f4da-441c-a3fe-f4f15abdfb5d",
"created_at": 1778872159.0741,
"updated_at": 1778872159.0741,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "26b2cf7a-ca8c-4857-98ee-dd68954feac1/92ed20d0-5091-11f1-8248-cf8ab660e2ca.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92ed20d0-5091-11f1-8248-cf8ab660e2ca.png?Expires=1778958559080&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=OIbJ69AUiijccgUsLs8N8KsXuBbGIpmwOpk2Xn3rLAFFB-4vkYAkp5YAvmMgHdV0y6TPH6vgr6NnGn5qR9tYGW4gF6Y96cgdZHOFjInE6qVesl5ZDPXfUzsegzVyZEA7qG4z2RP0ty2BiKGS21tgy2nAmnR3RsOhcvnsAaX8ELiWj7uWPzHQQGPmsR6q7IXRsr~uZfw9bW7HVlnaXuF54j~9sw~jFqeknT1EOPURyfke-eXgJXIOBRSk4tn7Vm2xpH5y2E2eieOvm4SXVLbHsiX~OcKR1sPt3fBTbUCjNAa9HXNnEJVEseanGmsCXIPlFmJNVVcCDp62SvqXmYPCNg__",
"preview_url": "https://private-cdn.irish.rechat.com/26b2cf7a-ca8c-4857-98ee-dd68954feac1/92ed20d0-5091-11f1-8248-cf8ab660e2ca.png?Expires=1778958559080&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=OIbJ69AUiijccgUsLs8N8KsXuBbGIpmwOpk2Xn3rLAFFB-4vkYAkp5YAvmMgHdV0y6TPH6vgr6NnGn5qR9tYGW4gF6Y96cgdZHOFjInE6qVesl5ZDPXfUzsegzVyZEA7qG4z2RP0ty2BiKGS21tgy2nAmnR3RsOhcvnsAaX8ELiWj7uWPzHQQGPmsR6q7IXRsr~uZfw9bW7HVlnaXuF54j~9sw~jFqeknT1EOPURyfke-eXgJXIOBRSk4tn7Vm2xpH5y2E2eieOvm4SXVLbHsiX~OcKR1sPt3fBTbUCjNAa9HXNnEJVEseanGmsCXIPlFmJNVVcCDp62SvqXmYPCNg__",
"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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Request
Body
{
"items": [
"5d8ac210-701f-4e18-b3eb-c533f8ac45d7"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/8eba1310-5091-11f1-9f3b-a6e2379790b9.zip?hash=jFzKqWRAR2CuyYeRSzYhBf11h7qAIQSGXCtbf9tTLCuPCCZjH4fB6eNIkCkZFSa8kxDSPuwS29FDCKVDtEbmgEfBX7kWJ5cSkh3puldnfF9wg5WxjiM9LFcybr1WdrfQEGPBAzRU3EZ2R6d7aAylXW3L1ck8pX2rFuh6YCoRBVKFCeqzv8aof7YNuyS70XyXhTceCDhL5hqM1X0k4rUjqzV25%2FckF1oArT6eDxJp%2BC6bE7M%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: 26b2cf7a-ca8c-4857-98ee-dd68954feac1
Response
200Body
{
"code": "OK",
"data": {
"id": "de06529c-212f-48dc-8350-6ad66eb75cdd",
"created_at": 1778872159.531596,
"updated_at": 1778872159.531596,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/26b2cf7a-ca8c-4857-98ee-dd68954feac1/93317cd0-5091-11f1-8248-cf8ab660e2ca.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/26b2cf7a-ca8c-4857-98ee-dd68954feac1/93317cd0-5091-11f1-8248-cf8ab660e2ca.zip?Expires=1778958559535&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=X4NxSGJxvxsFt9qi1xCmIaawSSD2ikbSzfU46Q1hByJs-B2fyuI95F96zEga21OAvqY8O3tinKNX7IgbuRXrw64X2j5d1nE5wmD1ycuN1QwDNbRvHdxlrP5vzGH7cVQ38JPpaB355Jcyojv87v2QLxp9OebaXe8oEQZte4oUpaxGR~8og0bht7SjnJg-aFGqxzJ-o4MHaugGk2y9UdpqsMqi1frL5Ef7z8B57wSjz1ka-djfDvDiB6S3F7ZKnP13fpH-h8nH~oty0im1bR0dS1BV8Swe0lMW3gEZ6S8f9tgdpRc0r6dIqiTUVrUrm66lkyTHRFaM72ZyBM5xGY48Tw__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}