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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Response
200Body
{
"code": "OK",
"data": {
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"number": 6,
"faired_at": "2026-10-10T18:21:04.464Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "db54aa96-7753-4c6c-b076-7156a7eb9abe",
"created_at": 1791656464.505303,
"updated_at": 1791656464.505303,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "SellerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"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,
"origin": "rechat",
"skyslope_role": 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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a6e4c370-6c37-4f68-8660-f0016a71c415",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "acc87508-4536-4300-94a3-aca837dbffaa",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "55ae801d-004d-4ebd-8204-a50ccca4c1c9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "e76361bc-fee1-474e-9aa1-d2922cdf748f",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "501cf9ad-861f-49d1-bc90-ddb9a8c29119",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "1eb8b331-688f-4415-a046-e6e874f11a78",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3036f538-d7e5-4ad7-ae29-86e7d69aa908",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a5bb8fb0-140f-49eb-aec2-46ecbdd79b88",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "97edb12f-7022-44af-b911-3f639f772e22",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c30fa669-a092-417c-9899-b1be4d8a9668",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3f54d7b8-66d9-4864-bbd2-9f85c8ff2bd4",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "7c0cb317-3652-4298-9479-6bb3d4ec85ee",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "614fd17c-3aee-48a0-bbbc-2fef767a943b",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "051add57-a292-429b-b946-4d367884010c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "16e6a82b-bac9-4637-856e-62b77f99cea9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "299de24b-089e-4c35-b08c-4f290185d8b3",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "af6226b2-c8c6-4d57-a962-cf36cfe58e4c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "8fa5d32d-eb3f-45df-a79e-240216d17999",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c003f0c3-49b7-4066-abb5-6e28804631cb",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a18298bb-7092-4393-bcb2-cd176bfba962",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "01e3a560-ffd0-470f-8d3b-44fc03eecfaf",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Get deals created by a user ¶
Get deals created by a userGET/deals
This endpoint is marked for deprecation on 2026-01-01.
Example URI
GET /deals
Response
200Body
{
"code": "OK",
"data": [
{
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"number": 6,
"faired_at": "2026-10-10T18:21:04.464Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "db54aa96-7753-4c6c-b076-7156a7eb9abe",
"created_at": 1791656464.505303,
"updated_at": 1791656464.505303,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "SellerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"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,
"origin": "rechat",
"skyslope_role": 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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a6e4c370-6c37-4f68-8660-f0016a71c415",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "acc87508-4536-4300-94a3-aca837dbffaa",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "55ae801d-004d-4ebd-8204-a50ccca4c1c9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "e76361bc-fee1-474e-9aa1-d2922cdf748f",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "501cf9ad-861f-49d1-bc90-ddb9a8c29119",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "1eb8b331-688f-4415-a046-e6e874f11a78",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3036f538-d7e5-4ad7-ae29-86e7d69aa908",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a5bb8fb0-140f-49eb-aec2-46ecbdd79b88",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "97edb12f-7022-44af-b911-3f639f772e22",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c30fa669-a092-417c-9899-b1be4d8a9668",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3f54d7b8-66d9-4864-bbd2-9f85c8ff2bd4",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "7c0cb317-3652-4298-9479-6bb3d4ec85ee",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "614fd17c-3aee-48a0-bbbc-2fef767a943b",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "051add57-a292-429b-b946-4d367884010c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "16e6a82b-bac9-4637-856e-62b77f99cea9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "299de24b-089e-4c35-b08c-4f290185d8b3",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "af6226b2-c8c6-4d57-a962-cf36cfe58e4c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "8fa5d32d-eb3f-45df-a79e-240216d17999",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c003f0c3-49b7-4066-abb5-6e28804631cb",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a18298bb-7092-4393-bcb2-cd176bfba962",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "01e3a560-ffd0-470f-8d3b-44fc03eecfaf",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 0
}
}Get all deals belonging to a brand ¶
Get all deals belonging to a brandGET/brands/:brand/deals
Example URI
GET /brands/:brand/deals
URI Parameters
- brand
string(required) Example: fbcbc472-eb22-409d-97b0-dc3268ef7e71
Response
200Body
{
"code": "OK",
"data": [
{
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"number": 6,
"faired_at": "2026-10-10T18:21:04.464Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "db54aa96-7753-4c6c-b076-7156a7eb9abe",
"created_at": 1791656464.505303,
"updated_at": 1791656464.505303,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "SellerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"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,
"origin": "rechat",
"skyslope_role": 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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a6e4c370-6c37-4f68-8660-f0016a71c415",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "acc87508-4536-4300-94a3-aca837dbffaa",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "55ae801d-004d-4ebd-8204-a50ccca4c1c9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "e76361bc-fee1-474e-9aa1-d2922cdf748f",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "501cf9ad-861f-49d1-bc90-ddb9a8c29119",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "1eb8b331-688f-4415-a046-e6e874f11a78",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3036f538-d7e5-4ad7-ae29-86e7d69aa908",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a5bb8fb0-140f-49eb-aec2-46ecbdd79b88",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "97edb12f-7022-44af-b911-3f639f772e22",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c30fa669-a092-417c-9899-b1be4d8a9668",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3f54d7b8-66d9-4864-bbd2-9f85c8ff2bd4",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "7c0cb317-3652-4298-9479-6bb3d4ec85ee",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "614fd17c-3aee-48a0-bbbc-2fef767a943b",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "051add57-a292-429b-b946-4d367884010c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "16e6a82b-bac9-4637-856e-62b77f99cea9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "299de24b-089e-4c35-b08c-4f290185d8b3",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "af6226b2-c8c6-4d57-a962-cf36cfe58e4c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "8fa5d32d-eb3f-45df-a79e-240216d17999",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c003f0c3-49b7-4066-abb5-6e28804631cb",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a18298bb-7092-4393-bcb2-cd176bfba962",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "01e3a560-ffd0-470f-8d3b-44fc03eecfaf",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 1
}
}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: fbcbc472-eb22-409d-97b0-dc3268ef7e71- associations
string(required) Example: deal.inboxes
Response
200Body
{
"code": "OK",
"data": [
{
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"number": 6,
"faired_at": "2026-10-10T18:21:04.464Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1791656466.616387,
"is_draft": false,
"roles": [
{
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "db54aa96-7753-4c6c-b076-7156a7eb9abe",
"created_at": 1791656464.505303,
"updated_at": 1791656464.505303,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "SellerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"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,
"origin": "rechat",
"skyslope_role": 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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a6e4c370-6c37-4f68-8660-f0016a71c415",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "acc87508-4536-4300-94a3-aca837dbffaa",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "55ae801d-004d-4ebd-8204-a50ccca4c1c9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "e76361bc-fee1-474e-9aa1-d2922cdf748f",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "501cf9ad-861f-49d1-bc90-ddb9a8c29119",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "1eb8b331-688f-4415-a046-e6e874f11a78",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3036f538-d7e5-4ad7-ae29-86e7d69aa908",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a5bb8fb0-140f-49eb-aec2-46ecbdd79b88",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "97edb12f-7022-44af-b911-3f639f772e22",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c30fa669-a092-417c-9899-b1be4d8a9668",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3f54d7b8-66d9-4864-bbd2-9f85c8ff2bd4",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "7c0cb317-3652-4298-9479-6bb3d4ec85ee",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "614fd17c-3aee-48a0-bbbc-2fef767a943b",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "051add57-a292-429b-b946-4d367884010c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "16e6a82b-bac9-4637-856e-62b77f99cea9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "299de24b-089e-4c35-b08c-4f290185d8b3",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "af6226b2-c8c6-4d57-a962-cf36cfe58e4c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "8fa5d32d-eb3f-45df-a79e-240216d17999",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c003f0c3-49b7-4066-abb5-6e28804631cb",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a18298bb-7092-4393-bcb2-cd176bfba962",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "01e3a560-ffd0-470f-8d3b-44fc03eecfaf",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": [
{
"id": "c8122666-c0b2-4e50-8e4c-7ecf56105301",
"brand": "69419872-ac6c-469a-b28a-b3cf1b212acb",
"label": "Contract Inbox",
"created_by": null,
"listing_default": false,
"contract_default": true,
"created_at": 1791656464.023817,
"deleted_at": null,
"type": "deal_inbox"
}
],
"attention_requests": 1,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 0
}
}Search through all deals ¶
Search through all dealsPOST/deals/filter
Sort object looks like the following:
{
$order: {
direction, // DESC or ASC
field, // Used for some of the base properties of the deal like deal.title, deal.created_at, deal.faired_at, deal.property_type
context: { // Used for sorting based on dynamic deal contexts.
type, // Type of field you are applying the sorting to. either `number` or `date`
fields: [] // Array of names of contexts. like ['sales_price', 'list_price']
}
}
}Example URI
POST /deals/filter
Request
Body
{
"query": "5020 Junius Street",
"$order": {
"field": "deals.updated_at",
"direction": "DESC"
},
"limit": 100,
"start": 0
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"number": 6,
"faired_at": "2026-10-10T18:21:04.464Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "db54aa96-7753-4c6c-b076-7156a7eb9abe",
"created_at": 1791656464.505303,
"updated_at": 1791656464.505303,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "SellerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"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,
"origin": "rechat",
"skyslope_role": 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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a6e4c370-6c37-4f68-8660-f0016a71c415",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "acc87508-4536-4300-94a3-aca837dbffaa",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "55ae801d-004d-4ebd-8204-a50ccca4c1c9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "e76361bc-fee1-474e-9aa1-d2922cdf748f",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "501cf9ad-861f-49d1-bc90-ddb9a8c29119",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "1eb8b331-688f-4415-a046-e6e874f11a78",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3036f538-d7e5-4ad7-ae29-86e7d69aa908",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a5bb8fb0-140f-49eb-aec2-46ecbdd79b88",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "97edb12f-7022-44af-b911-3f639f772e22",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c30fa669-a092-417c-9899-b1be4d8a9668",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3f54d7b8-66d9-4864-bbd2-9f85c8ff2bd4",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "7c0cb317-3652-4298-9479-6bb3d4ec85ee",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "614fd17c-3aee-48a0-bbbc-2fef767a943b",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "051add57-a292-429b-b946-4d367884010c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "16e6a82b-bac9-4637-856e-62b77f99cea9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "299de24b-089e-4c35-b08c-4f290185d8b3",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "af6226b2-c8c6-4d57-a962-cf36cfe58e4c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "8fa5d32d-eb3f-45df-a79e-240216d17999",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c003f0c3-49b7-4066-abb5-6e28804631cb",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a18298bb-7092-4393-bcb2-cd176bfba962",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "01e3a560-ffd0-470f-8d3b-44fc03eecfaf",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 1
}
}Create a deal with a listing ¶
Create a deal with a listingPOST/deals
Example URI
POST /deals
URI Parameters
- associations
string(required) Example: deal.gallery,deal.property_type,brand_property_type.checklists
Request
Body
{
"deal_type": "Buying",
"is_draft": true,
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8"
}Response
200Body
{
"code": "OK",
"data": {
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"number": 6,
"faired_at": null,
"title": "[Draft]",
"gallery": {
"id": "5a9bf69c-c4d7-11f1-a240-ea05dd1fc3a8",
"created_at": 1791656464.237943,
"updated_at": 1791656464.237943,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"created_at": 1791656464.109622,
"updated_at": 1791656464.109622,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"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": "96cad8fc-40f2-4820-bc3f-a300cb73118d",
"created_at": 1791656463.730189,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"checklist_type": "Selling",
"inbox": "92dfcef9-b0ea-4024-8894-2fa469cf631c",
"type": "brand_checklist",
"tasks": null
},
{
"id": "1c6e48a1-a9c5-4d73-8bfd-0dd5283a8406",
"created_at": 1791656463.730189,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"checklist_type": "Buying",
"inbox": "c8122666-c0b2-4e50-8e4c-7ecf56105301",
"type": "brand_checklist",
"tasks": null
},
{
"id": "2c901747-2425-4f88-9e77-bdcd1e912d8a",
"created_at": 1791656463.730189,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"checklist_type": "Offer",
"inbox": "c8122666-c0b2-4e50-8e4c-7ecf56105301",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": false,
"email": "[email protected]"
}
}Delete a deal ¶
Delete a dealDELETE/deals/:id
Example URI
DELETE /deals/:id
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2
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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
{
"id": "db54aa96-7753-4c6c-b076-7156a7eb9abe",
"created_at": 1791656464.505303,
"updated_at": 1791656464.505303,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "SellerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"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,
"origin": "rechat",
"skyslope_role": 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: b38a9f39-58dd-44fb-93fb-7beccad10fa2- rid
string(required) Example: 0d21e4a8-4abc-4cb8-9354-9613f70afa8f
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f"
}Response
200Body
{
"code": "OK",
"data": {
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": 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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"number": 6,
"faired_at": null,
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a6e4c370-6c37-4f68-8660-f0016a71c415",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "acc87508-4536-4300-94a3-aca837dbffaa",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "55ae801d-004d-4ebd-8204-a50ccca4c1c9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "e76361bc-fee1-474e-9aa1-d2922cdf748f",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "501cf9ad-861f-49d1-bc90-ddb9a8c29119",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "1eb8b331-688f-4415-a046-e6e874f11a78",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3036f538-d7e5-4ad7-ae29-86e7d69aa908",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a5bb8fb0-140f-49eb-aec2-46ecbdd79b88",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "97edb12f-7022-44af-b911-3f639f772e22",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c30fa669-a092-417c-9899-b1be4d8a9668",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3f54d7b8-66d9-4864-bbd2-9f85c8ff2bd4",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "7c0cb317-3652-4298-9479-6bb3d4ec85ee",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "614fd17c-3aee-48a0-bbbc-2fef767a943b",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "051add57-a292-429b-b946-4d367884010c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "16e6a82b-bac9-4637-856e-62b77f99cea9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "299de24b-089e-4c35-b08c-4f290185d8b3",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "af6226b2-c8c6-4d57-a962-cf36cfe58e4c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "8fa5d32d-eb3f-45df-a79e-240216d17999",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c003f0c3-49b7-4066-abb5-6e28804631cb",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a18298bb-7092-4393-bcb2-cd176bfba962",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "01e3a560-ffd0-470f-8d3b-44fc03eecfaf",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Change property type of a deal ¶
Change property type of a dealPATCH/deals/:id/property_type
Example URI
PATCH /deals/:id/property_type
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8"
}Response
200Body
{
"code": "OK",
"data": {
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"number": 6,
"faired_at": null,
"title": "5020 Junius Street",
"property_type": {
"id": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"created_at": 1791656464.109622,
"updated_at": 1791656464.109622,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"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": "96cad8fc-40f2-4820-bc3f-a300cb73118d",
"created_at": 1791656463.730189,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"checklist_type": "Selling",
"inbox": "92dfcef9-b0ea-4024-8894-2fa469cf631c",
"type": "brand_checklist",
"tasks": null
},
{
"id": "1c6e48a1-a9c5-4d73-8bfd-0dd5283a8406",
"created_at": 1791656463.730189,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"checklist_type": "Buying",
"inbox": "c8122666-c0b2-4e50-8e4c-7ecf56105301",
"type": "brand_checklist",
"tasks": null
},
{
"id": "2c901747-2425-4f88-9e77-bdcd1e912d8a",
"created_at": 1791656463.730189,
"deleted_at": null,
"brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8",
"checklist_type": "Offer",
"inbox": "c8122666-c0b2-4e50-8e4c-7ecf56105301",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a6e4c370-6c37-4f68-8660-f0016a71c415",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "acc87508-4536-4300-94a3-aca837dbffaa",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "55ae801d-004d-4ebd-8204-a50ccca4c1c9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "e76361bc-fee1-474e-9aa1-d2922cdf748f",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "501cf9ad-861f-49d1-bc90-ddb9a8c29119",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "1eb8b331-688f-4415-a046-e6e874f11a78",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3036f538-d7e5-4ad7-ae29-86e7d69aa908",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a5bb8fb0-140f-49eb-aec2-46ecbdd79b88",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "97edb12f-7022-44af-b911-3f639f772e22",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c30fa669-a092-417c-9899-b1be4d8a9668",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "3f54d7b8-66d9-4864-bbd2-9f85c8ff2bd4",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "7c0cb317-3652-4298-9479-6bb3d4ec85ee",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "614fd17c-3aee-48a0-bbbc-2fef767a943b",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "051add57-a292-429b-b946-4d367884010c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "16e6a82b-bac9-4637-856e-62b77f99cea9",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "299de24b-089e-4c35-b08c-4f290185d8b3",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "af6226b2-c8c6-4d57-a962-cf36cfe58e4c",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "8fa5d32d-eb3f-45df-a79e-240216d17999",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "c003f0c3-49b7-4066-abb5-6e28804631cb",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "a18298bb-7092-4393-bcb2-cd176bfba962",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "MLS",
"definition": "01e3a560-ffd0-470f-8d3b-44fc03eecfaf",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Add Context to a deal ¶
Add Context to a dealPOST/deals/:id/context
Example URI
POST /deals/:id/context
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Request
Body
{
"context": [
{
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"value": "2017/12/06"
},
{
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Set approval status for a context ¶
Set approval status for a contextPATCH/deals/:id/context/:cid/approved
Example URI
PATCH /deals/:id/context/:cid/approved
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2- cid
string(required) Example: 4b7074ad-0fd1-488f-beb6-69c10e3829e7
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_at": 1791656464.237864,
"updated_at": 1791656464.237864,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "f48596d9-6ae8-446f-92b8-c404a22eb7df",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.324972+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "b1506293-510b-4a71-af6a-3063769649ef",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": null,
"source": "PropertyType",
"definition": "2b312dc1-4d7d-470c-9452-16f65e82d254",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": "2026-10-10T18:21:04.32323+00:00",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"approved_at": "2026-10-10T18:21:04.355553+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"source": "Provided",
"definition": "4738aa18-c67c-40f7-b579-70e915bd8268",
"searchable": "'2017/12/06':1",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
}Get history for a deal context on a deal ¶
Get history for a deal context on a dealGET/deals/:id/context/:cname
Example URI
GET /deals/:id/context/:cname
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "4b7074ad-0fd1-488f-beb6-69c10e3829e7",
"type": "deal_context_item",
"created_at": 1791656464.32323,
"approved_at": 1791656464.355553,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d"
}
],
"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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "0d21e4a8-4abc-4cb8-9354-9613f70afa8f",
"created_at": 1791656464.504188,
"updated_at": 1791656464.504188,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "BuyerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"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,
"origin": "rechat",
"skyslope_role": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
{
"id": "db54aa96-7753-4c6c-b076-7156a7eb9abe",
"created_at": 1791656464.505303,
"updated_at": 1791656464.505303,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"role": "SellerAgent",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1493115498.770744,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Admin",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": false,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"bio": null,
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"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,
"origin": "rechat",
"skyslope_role": 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: b38a9f39-58dd-44fb-93fb-7beccad10fa2- rid
string(required) Example: 0d21e4a8-4abc-4cb8-9354-9613f70afa8f
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "95c0114d-a764-46cf-b3f0-07e7d280c4e8"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "0584963e-a762-4145-9760-2cd611a3f93d",
"created_at": 1791656463.730189,
"updated_at": 1791656463.730189,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"order": 1,
"origin": "2c901747-2425-4f88-9e77-bdcd1e912d8a",
"terminated_at": null,
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": false,
"is_terminated": false,
"tasks": null,
"context": {},
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"inbox": "c8122666-c0b2-4e50-8e4c-7ecf56105301",
"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: b38a9f39-58dd-44fb-93fb-7beccad10fa2- cid
string(required) Example: 0584963e-a762-4145-9760-2cd611a3f93d
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "0584963e-a762-4145-9760-2cd611a3f93d"
}Response
200Body
{
"code": "OK",
"data": {
"id": "0584963e-a762-4145-9760-2cd611a3f93d",
"created_at": 1791656463.730189,
"updated_at": 1791656463.730189,
"deleted_at": null,
"deactivated_at": "2026-10-10T18:21:06.781Z",
"title": "Updated Checklist 1",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"order": 3,
"origin": "2c901747-2425-4f88-9e77-bdcd1e912d8a",
"terminated_at": "2026-10-10T18:21:06.781Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "7cf317f2-c26b-4898-95ca-c28bca71641e",
"created_at": 1791656464.865215,
"updated_at": 1791656466.738693,
"room": {
"type": "room",
"id": "5ff70e4d-d30f-4b66-b6a0-166a6067767c",
"title": "5020 Junius Street: Test Title",
"created_at": 1791656464.858997,
"updated_at": 1791656466.589031,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4d3073f0-8420-48c4-8207-db5f23996ba6",
"last_revision": "7200bdb9-9556-4c95-a80c-bc4ea46130f1",
"state": "Fair",
"created_at": 1791656465.923742,
"updated_at": 1791656466.159561,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"formstack_id": null,
"author": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "f83aad3e-157c-4679-ac12-1ca91c81c459",
"created_at": 1791656466.169384,
"updated_at": 1791656466.169384,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742866170&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=iltIAEmodxgtaaGBTeBFnq1PyOBUpl02ApfrVBeje6gmo17a2dKH-Tavx8cThRK~Me7dj5GDufIO3qbScdEMQ-G75R1koFjlls9x4raa9e1qtzH9RHMWdDHo~G-49efArhErvcBVMnjddw5FoaVhhIwgM00NmlgLq1liLGbQ~a8wai24uwf1oDQr3YrzLVmsrrM4HU~k0DTday3IHXGZ0i1c7ejKcgyhSCzvZGgAcGnOUQ9sNTztZv9ZtjXag69ww9wbPLNvrOOeMoVHlhnCwI4884IJhQCW5Ux77J~jGixegGDCsOmgvl0NcHW-M3cwcaz5kBqQ8mFEmtO40Z9zOg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "9b08e902-9c8e-449d-aca6-f4cfd00ca661",
"created_at": 1791656466.357237,
"type": "review",
"status": "Declined",
"updated_at": 1791656466.359289
},
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/submission.pdf?hash=jFzZqXtHACj13N7VQGJ0Av5r1bibdhmLVT9SY4RXYnPEWHZ2HNLF7OFJnS9FB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2kAuFzd0IATg%3D%3D"
}
],
"context": {},
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"inbox": "c8122666-c0b2-4e50-8e4c-7ecf56105301",
"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: 7cf317f2-c26b-4898-95ca-c28bca71641e
Response
200Body
{
"code": "OK",
"data": {
"id": "7cf317f2-c26b-4898-95ca-c28bca71641e",
"created_at": 1791656464.865215,
"updated_at": 1791656465.944167,
"room": {
"type": "room",
"id": "5ff70e4d-d30f-4b66-b6a0-166a6067767c",
"title": "5020 Junius Street: Test Title",
"created_at": 1791656464.858997,
"updated_at": 1791656466.25738,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4d3073f0-8420-48c4-8207-db5f23996ba6",
"last_revision": "7200bdb9-9556-4c95-a80c-bc4ea46130f1",
"state": "Fair",
"created_at": 1791656465.923742,
"updated_at": 1791656466.159561,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"formstack_id": null,
"author": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "f83aad3e-157c-4679-ac12-1ca91c81c459",
"created_at": 1791656466.169384,
"updated_at": 1791656466.169384,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742866170&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=iltIAEmodxgtaaGBTeBFnq1PyOBUpl02ApfrVBeje6gmo17a2dKH-Tavx8cThRK~Me7dj5GDufIO3qbScdEMQ-G75R1koFjlls9x4raa9e1qtzH9RHMWdDHo~G-49efArhErvcBVMnjddw5FoaVhhIwgM00NmlgLq1liLGbQ~a8wai24uwf1oDQr3YrzLVmsrrM4HU~k0DTday3IHXGZ0i1c7ejKcgyhSCzvZGgAcGnOUQ9sNTztZv9ZtjXag69ww9wbPLNvrOOeMoVHlhnCwI4884IJhQCW5Ux77J~jGixegGDCsOmgvl0NcHW-M3cwcaz5kBqQ8mFEmtO40Z9zOg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/submission.pdf?hash=jFzZqXtHACj13N7VQGJ0Av5r1bibdhmLVT9SY4RXYnPEWHZ2HNLF7OFJnS9FB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2kAupxeUIATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"is_deletable": true,
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"room": "5ff70e4d-d30f-4b66-b6a0-166a6067767c"
}Response
200Body
{
"code": "OK",
"data": {
"id": "7cf317f2-c26b-4898-95ca-c28bca71641e",
"created_at": 1791656464.865215,
"updated_at": 1791656464.865215,
"room": {
"type": "room",
"id": "5ff70e4d-d30f-4b66-b6a0-166a6067767c",
"title": "5020 Junius Street: Test Title",
"created_at": 1791656464.858997,
"updated_at": 1791656464.900498,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/submission.pdf?hash=jFzZqXtHACj13N7VQGJ0Av5r1bibdhmLVT9SY4RXYnPEWHZ2HNLF7OFJnS9FB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2mAuB0fUIATg%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: 7cf317f2-c26b-4898-95ca-c28bca71641e
Request
Body
{
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"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": "4d3073f0-8420-48c4-8207-db5f23996ba6",
"last_revision": "e4882fe8-7583-4ec8-b92f-ffac31a68c96",
"state": "Fair",
"created_at": 1791656465.923742,
"updated_at": 1791656466.040825,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"formstack_id": null,
"author": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "aa99fdd7-184d-49cd-9eb8-40000254c9a0",
"created_at": 1791656466.052061,
"updated_at": 1791656466.052061,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5baf3da0-c4d7-11f1-89da-fb554657817f.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5baf3da0-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742866053&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PEoGs1xGD-cpdDba0PYLl2HDzFIzHPgGcTJvw8yml-Y4VgoXNX1V6cQ5AT9Eq21I-4xBqlx-9WliB7CWW9oruSOiMeM6C4yFtWYptrRUZsQcMtqLok6-ocMCNVLfl3ujbTKM3hn-Yj14CKLF2PXWgxx2Mv2tcgwcFoHclMsVq03GisuXH-eEBz0v5ad~ziecmSH6f8VuRP4jagzBA4CZ1T7IYk7--AReDnJHCk734Upjwtl-R~1GcbuoV6U2xtH~MFZXahBTI9EDlkFO7N-aZpcwQ6h5p3InvvKP9KZhDyo6PE3UbFMdCitpMX6G8ezn~JZ7ctgKjdgctKKyy8Gosw__",
"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: 7cf317f2-c26b-4898-95ca-c28bca71641e- revision
string(required) Example: e4882fe8-7583-4ec8-b92f-ffac31a68c96
Response
200Body
{
"code": "OK",
"data": {
"id": "e4882fe8-7583-4ec8-b92f-ffac31a68c96",
"submission": "4d3073f0-8420-48c4-8207-db5f23996ba6",
"created_at": 1791656465.923742,
"updated_at": 1791656466.040825,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"author": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "aa99fdd7-184d-49cd-9eb8-40000254c9a0"
}
}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: 7cf317f2-c26b-4898-95ca-c28bca71641e
Request
Body
{
"status": "Declined",
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0"
}Response
200Body
{
"code": "OK",
"data": {
"id": "7cf317f2-c26b-4898-95ca-c28bca71641e",
"created_at": 1791656464.865215,
"updated_at": 1791656466.362506,
"room": {
"type": "room",
"id": "5ff70e4d-d30f-4b66-b6a0-166a6067767c",
"title": "5020 Junius Street: Test Title",
"created_at": 1791656464.858997,
"updated_at": 1791656466.37642,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4d3073f0-8420-48c4-8207-db5f23996ba6",
"last_revision": "7200bdb9-9556-4c95-a80c-bc4ea46130f1",
"state": "Fair",
"created_at": 1791656465.923742,
"updated_at": 1791656466.159561,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"formstack_id": null,
"author": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "f83aad3e-157c-4679-ac12-1ca91c81c459",
"created_at": 1791656466.169384,
"updated_at": 1791656466.169384,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742866170&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=iltIAEmodxgtaaGBTeBFnq1PyOBUpl02ApfrVBeje6gmo17a2dKH-Tavx8cThRK~Me7dj5GDufIO3qbScdEMQ-G75R1koFjlls9x4raa9e1qtzH9RHMWdDHo~G-49efArhErvcBVMnjddw5FoaVhhIwgM00NmlgLq1liLGbQ~a8wai24uwf1oDQr3YrzLVmsrrM4HU~k0DTday3IHXGZ0i1c7ejKcgyhSCzvZGgAcGnOUQ9sNTztZv9ZtjXag69ww9wbPLNvrOOeMoVHlhnCwI4884IJhQCW5Ux77J~jGixegGDCsOmgvl0NcHW-M3cwcaz5kBqQ8mFEmtO40Z9zOg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "9b08e902-9c8e-449d-aca6-f4cfd00ca661",
"created_at": 1791656466.357237,
"type": "review",
"status": "Declined",
"updated_at": 1791656466.359289
},
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/submission.pdf?hash=jFzZqXtHACj13N7VQGJ0Av5r1bibdhmLVT9SY4RXYnPEWHZ2HNLF7OFJnS9FB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2kAu1xd0IATg%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: 7cf317f2-c26b-4898-95ca-c28bca71641e
Request
Body
{
"attention_requested": true,
"ai_review": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "7cf317f2-c26b-4898-95ca-c28bca71641e",
"created_at": 1791656464.865215,
"updated_at": 1791656466.616387,
"room": {
"type": "room",
"id": "5ff70e4d-d30f-4b66-b6a0-166a6067767c",
"title": "5020 Junius Street: Test Title",
"created_at": 1791656464.858997,
"updated_at": 1791656466.589031,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": {
"id": "4d3073f0-8420-48c4-8207-db5f23996ba6",
"last_revision": "7200bdb9-9556-4c95-a80c-bc4ea46130f1",
"state": "Fair",
"created_at": 1791656465.923742,
"updated_at": 1791656466.159561,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"formstack_id": null,
"author": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "f83aad3e-157c-4679-ac12-1ca91c81c459",
"created_at": 1791656466.169384,
"updated_at": 1791656466.169384,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5bc16610-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742866170&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=iltIAEmodxgtaaGBTeBFnq1PyOBUpl02ApfrVBeje6gmo17a2dKH-Tavx8cThRK~Me7dj5GDufIO3qbScdEMQ-G75R1koFjlls9x4raa9e1qtzH9RHMWdDHo~G-49efArhErvcBVMnjddw5FoaVhhIwgM00NmlgLq1liLGbQ~a8wai24uwf1oDQr3YrzLVmsrrM4HU~k0DTday3IHXGZ0i1c7ejKcgyhSCzvZGgAcGnOUQ9sNTztZv9ZtjXag69ww9wbPLNvrOOeMoVHlhnCwI4884IJhQCW5Ux77J~jGixegGDCsOmgvl0NcHW-M3cwcaz5kBqQ8mFEmtO40Z9zOg__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "9b08e902-9c8e-449d-aca6-f4cfd00ca661",
"created_at": 1791656466.357237,
"type": "review",
"status": "Declined",
"updated_at": 1791656466.359289
},
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-10-10T18:21:06.616Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/submission.pdf?hash=jFzZqXtHACj13N7VQGJ0Av5r1bibdhmLVT9SY4RXYnPEWHZ2HNLF7OFJnS9FB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2kAu93fEIATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: 40343233-7cd0-4b3a-9ce6-831fab26e1a6
Request
Body
{
"title": "Another Task for Gholi",
"required": false,
"ai_review": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "40343233-7cd0-4b3a-9ce6-831fab26e1a6",
"created_at": 1791656465.005452,
"updated_at": 1791656465.301079,
"room": {
"type": "room",
"id": "76c30239-4b48-491d-afd3-656082db3037",
"title": "5020 Junius Street: Another Task",
"created_at": 1791656465.000474,
"updated_at": 1791656465.040959,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/40343233-7cd0-4b3a-9ce6-831fab26e1a6/submission.pdf?hash=jFzZqXtHACj1342AR2BxV%2F9rgenJJBmLDzULY4QBZCTEA3d%2FGNDG6eYamH8WB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2nAupxfUIATg%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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Request
Body
[
{
"id": "7cf317f2-c26b-4898-95ca-c28bca71641e",
"title": "Bulk Test Title",
"ai_review": false
},
{
"id": "40343233-7cd0-4b3a-9ce6-831fab26e1a6",
"attention_requested": true,
"ai_review": false
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "7cf317f2-c26b-4898-95ca-c28bca71641e",
"created_at": 1791656464.865215,
"updated_at": 1791656465.354864,
"room": {
"type": "room",
"id": "5ff70e4d-d30f-4b66-b6a0-166a6067767c",
"title": "5020 Junius Street: Test Title",
"created_at": 1791656464.858997,
"updated_at": 1791656465.219363,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Bulk Test Title",
"task_type": "Form",
"submission": null,
"review": null,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"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": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/submission.pdf?hash=jFzZqXtHACj13N7VQGJ0Av5r1bibdhmLVT9SY4RXYnPEWHZ2HNLF7OFJnS9FB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2nAu11f0IATg%3D%3D"
},
{
"id": "40343233-7cd0-4b3a-9ce6-831fab26e1a6",
"created_at": 1791656465.005452,
"updated_at": 1791656465.413502,
"room": {
"type": "room",
"id": "76c30239-4b48-491d-afd3-656082db3037",
"title": "5020 Junius Street: Another Task",
"created_at": 1791656465.000474,
"updated_at": 1791656465.384704,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"dce23064-2e07-4bed-9e47-f1de64510ea0": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
}
],
"total_alerts": null,
"total_favorites": null,
"proposed_title": "John"
},
"title": "Another Task for Gholi",
"task_type": "Form",
"submission": null,
"review": null,
"form": "7a0090ac-c07d-473b-8a89-ea21619b3feb",
"checklist": "0584963e-a762-4145-9760-2cd611a3f93d",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-10-10T18:21:05.413Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "b38a9f39-58dd-44fb-93fb-7beccad10fa2",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/40343233-7cd0-4b3a-9ce6-831fab26e1a6/submission.pdf?hash=jFzZqXtHACj1342AR2BxV%2F9rgenJJBmLDzULY4QBZCTEA3d%2FGNDG6eYamH8WB2inxE%2BVOb1Ni5caT69A5ULgmheWQrwCcsVaxwG16E4yZwp3ypWz2yFtLAo2b6oeYPGdRmKCTXNE1lZyWqR9aA2gJG3Gu8o0pX2nAu11f0IATg%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: 7cf317f2-c26b-4898-95ca-c28bca71641e
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "aa99fdd7-184d-49cd-9eb8-40000254c9a0"
}Response
200Body
{
"code": "OK",
"data": {
"id": "4577661d-5f96-4d08-9efd-4601b148b9b2",
"reference": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"reference_type": "User",
"created_at": 1791656466.250968,
"updated_at": 1791656466.250969,
"deleted_at": null,
"object": {
"id": "aa99fdd7-184d-49cd-9eb8-40000254c9a0",
"created_at": 1791656466.052061,
"updated_at": 1791656466.052061,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5baf3da0-c4d7-11f1-89da-fb554657817f.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/7cf317f2-c26b-4898-95ca-c28bca71641e/5baf3da0-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742866053&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=PEoGs1xGD-cpdDba0PYLl2HDzFIzHPgGcTJvw8yml-Y4VgoXNX1V6cQ5AT9Eq21I-4xBqlx-9WliB7CWW9oruSOiMeM6C4yFtWYptrRUZsQcMtqLok6-ocMCNVLfl3ujbTKM3hn-Yj14CKLF2PXWgxx2Mv2tcgwcFoHclMsVq03GisuXH-eEBz0v5ad~ziecmSH6f8VuRP4jagzBA4CZ1T7IYk7--AReDnJHCk734Upjwtl-R~1GcbuoV6U2xtH~MFZXahBTI9EDlkFO7N-aZpcwQ6h5p3InvvKP9KZhDyo6PE3UbFMdCitpMX6G8ezn~JZ7ctgKjdgctKKyy8Gosw__",
"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: 7cf317f2-c26b-4898-95ca-c28bca71641e
Request
Body
{
"comment": "Comment",
"author": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"room": "5ff70e4d-d30f-4b66-b6a0-166a6067767c"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "5c5612cd-1728-4fc5-bbd4-388a38cfc822",
"id": "5c5612cd-1728-4fc5-bbd4-388a38cfc822",
"comment": "Comment",
"image_url": null,
"document_url": null,
"video_url": null,
"recommendation": null,
"author": {
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17784475394",
"created_at": 1791656463.73836,
"id": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1791656463.730189,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": false,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": null,
"personal_room": "e9d1a5de-e53c-4ad1-92ce-65a054ef6e46",
"brand": null,
"fake_email": null,
"features": null,
"last_seen_at": null,
"email_signature": "This is my signature.",
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"bio": "This is my bio.",
"current_time": "1:21 PM - Saturday Oct 10, 2026",
"push_allowed": true,
"agents": [
{
"id": "7204f0a8-3cf8-41e9-abb4-22b6e8d35f10",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "+19722644703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "+14693588080",
"generational_name": null,
"matrix_unique_id": "8320806",
"updated_at": 1791656463.837123,
"deleted_at": null,
"created_at": 1791656463.837123,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"+1XXXXXXXX80"
]
}
],
"last_seen_type": null,
"active_brand": "fbcbc472-eb22-409d-97b0-dc3268ef7e71",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1791656466.847478,
"updated_at": 1791656466.847478,
"room": "5ff70e4d-d30f-4b66-b6a0-166a6067767c",
"image_thumbnail_url": null,
"deleted_at": null,
"notification": null,
"reference": null,
"mentions": null,
"activity": null,
"role": null,
"attachments": [],
"files": null,
"email_campaigns": null,
"contacts": null,
"crm_tasks": null,
"compact_listings": null,
"input_forms": null,
"artifacts": null,
"websites": null,
"social_posts": null,
"print_campaigns": null,
"template_instances": null,
"brand_assets": null,
"acked_by": null,
"deliveries": null
}
}Delete a task ¶
Delete a taskDELETE/tasks/:task
Example URI
DELETE /tasks/:task
URI Parameters
- task
string(required) Example: 40343233-7cd0-4b3a-9ce6-831fab26e1a6
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Response
200Body
{
"code": "OK",
"data": {
"id": "1839ea87-cc6b-44e6-9410-3e072bc15929",
"created_at": 1791656467.183905,
"updated_at": 1791656467.183905,
"deleted_at": null,
"gallery": "5a9bf69c-c4d7-11f1-a240-ea05dd1fc3a8",
"name": null,
"order": 0,
"file": {
"id": "f98c48ee-4f24-4ac0-9199-94ee1fa9b42f",
"created_at": 1791656467.181154,
"updated_at": 1791656467.181154,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c5cbbb0-c4d7-11f1-89da-fb554657817f.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c5cbbb0-c4d7-11f1-89da-fb554657817f.png",
"preview_url": "https://test.cloudfront.net/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c5cbbb0-c4d7-11f1-89da-fb554657817f.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: b38a9f39-58dd-44fb-93fb-7beccad10fa2- iid
string(required) Example: 1839ea87-cc6b-44e6-9410-3e072bc15929
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "f98c48ee-4f24-4ac0-9199-94ee1fa9b42f"
}Response
200Body
{
"code": "OK",
"data": {
"id": "1839ea87-cc6b-44e6-9410-3e072bc15929",
"created_at": 1791656467.183905,
"updated_at": 1791656463.730189,
"deleted_at": null,
"gallery": "5a9bf69c-c4d7-11f1-a240-ea05dd1fc3a8",
"name": "Updated Name",
"order": 2,
"file": {
"id": "f98c48ee-4f24-4ac0-9199-94ee1fa9b42f",
"created_at": 1791656467.181154,
"updated_at": 1791656467.181154,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c5cbbb0-c4d7-11f1-89da-fb554657817f.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c5cbbb0-c4d7-11f1-89da-fb554657817f.png",
"preview_url": "https://test.cloudfront.net/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c5cbbb0-c4d7-11f1-89da-fb554657817f.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: b38a9f39-58dd-44fb-93fb-7beccad10fa2- iid
string(required) Example: 1839ea87-cc6b-44e6-9410-3e072bc15929
Response
200Body
{
"code": "OK",
"data": {
"id": "1839ea87-cc6b-44e6-9410-3e072bc15929",
"created_at": 1791656467.183905,
"updated_at": 1791656463.730189,
"deleted_at": null,
"gallery": "5a9bf69c-c4d7-11f1-a240-ea05dd1fc3a8",
"name": "Updated Name",
"order": 2,
"file": {
"id": "8077731f-4328-4d7c-9c8b-9e206ec03fac",
"created_at": 1791656467.230561,
"updated_at": 1791656467.230561,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c645cd0-c4d7-11f1-89da-fb554657817f.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c645cd0-c4d7-11f1-89da-fb554657817f.png?Expires=1791742867232&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=P1SWfuta6dteusP4i-0ydM3eETDUPxhhn9Qxb9w6Ozg2d-TKHKUWhrNkF9b9HspGi5rbOsX~LdFK~9KP1sA~2ilhjegS~nIDRcP0Xv88hqIPuaN~TCO6NBjnWiSmfu11OezTkyQgnLPlhNpFUFGWZ0~74pP9du3kYI75NG0BYc2aRHxIBdOA7riQEzGaBHW94wt8r~mmga48mTQnXuBVLC6HmXLIo1EA1EWUtn2AnQPDjYWB1uewk6j-FjFQ8ie-bf4eEztPhTgJpE3ryvpSziEYQa1NKpPqmTL-9a~MXh70Snh-Enq5l7Isu1-BjgDgXrybbK46d5r4TV65fERY-Q__",
"preview_url": "https://private-cdn.irish.rechat.com/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c645cd0-c4d7-11f1-89da-fb554657817f.png?Expires=1791742867232&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=P1SWfuta6dteusP4i-0ydM3eETDUPxhhn9Qxb9w6Ozg2d-TKHKUWhrNkF9b9HspGi5rbOsX~LdFK~9KP1sA~2ilhjegS~nIDRcP0Xv88hqIPuaN~TCO6NBjnWiSmfu11OezTkyQgnLPlhNpFUFGWZ0~74pP9du3kYI75NG0BYc2aRHxIBdOA7riQEzGaBHW94wt8r~mmga48mTQnXuBVLC6HmXLIo1EA1EWUtn2AnQPDjYWB1uewk6j-FjFQ8ie-bf4eEztPhTgJpE3ryvpSziEYQa1NKpPqmTL-9a~MXh70Snh-Enq5l7Isu1-BjgDgXrybbK46d5r4TV65fERY-Q__",
"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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Request
Body
[
{
"id": "1839ea87-cc6b-44e6-9410-3e072bc15929",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "1839ea87-cc6b-44e6-9410-3e072bc15929",
"created_at": 1791656467.183905,
"updated_at": 1791656463.730189,
"deleted_at": 1791656463.730189,
"gallery": "5a9bf69c-c4d7-11f1-a240-ea05dd1fc3a8",
"name": "Updated Name",
"order": 3,
"file": {
"id": "8077731f-4328-4d7c-9c8b-9e206ec03fac",
"created_at": 1791656467.230561,
"updated_at": 1791656467.230561,
"deleted_at": null,
"created_by": "dce23064-2e07-4bed-9e47-f1de64510ea0",
"path": "b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c645cd0-c4d7-11f1-89da-fb554657817f.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c645cd0-c4d7-11f1-89da-fb554657817f.png?Expires=1791742867232&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=P1SWfuta6dteusP4i-0ydM3eETDUPxhhn9Qxb9w6Ozg2d-TKHKUWhrNkF9b9HspGi5rbOsX~LdFK~9KP1sA~2ilhjegS~nIDRcP0Xv88hqIPuaN~TCO6NBjnWiSmfu11OezTkyQgnLPlhNpFUFGWZ0~74pP9du3kYI75NG0BYc2aRHxIBdOA7riQEzGaBHW94wt8r~mmga48mTQnXuBVLC6HmXLIo1EA1EWUtn2AnQPDjYWB1uewk6j-FjFQ8ie-bf4eEztPhTgJpE3ryvpSziEYQa1NKpPqmTL-9a~MXh70Snh-Enq5l7Isu1-BjgDgXrybbK46d5r4TV65fERY-Q__",
"preview_url": "https://private-cdn.irish.rechat.com/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c645cd0-c4d7-11f1-89da-fb554657817f.png?Expires=1791742867232&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=P1SWfuta6dteusP4i-0ydM3eETDUPxhhn9Qxb9w6Ozg2d-TKHKUWhrNkF9b9HspGi5rbOsX~LdFK~9KP1sA~2ilhjegS~nIDRcP0Xv88hqIPuaN~TCO6NBjnWiSmfu11OezTkyQgnLPlhNpFUFGWZ0~74pP9du3kYI75NG0BYc2aRHxIBdOA7riQEzGaBHW94wt8r~mmga48mTQnXuBVLC6HmXLIo1EA1EWUtn2AnQPDjYWB1uewk6j-FjFQ8ie-bf4eEztPhTgJpE3ryvpSziEYQa1NKpPqmTL-9a~MXh70Snh-Enq5l7Isu1-BjgDgXrybbK46d5r4TV65fERY-Q__",
"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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Request
Body
{
"items": [
"1839ea87-cc6b-44e6-9410-3e072bc15929"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/5a9bf69c-c4d7-11f1-a240-ea05dd1fc3a8.zip?hash=jFzKqWRAR2CuyYeRRjJ6Bqpwj%2BmAdwDbWitbf9tTLHPbD3RjG9CU7rQbmHhDFiW9kxDSPuwS29FDCPkQsEbnhxPHX7lKdpASl07p6Vc8L1hxg5a0i3FqKFpmb%2B1TcrfQEGPBAzRU3EZ2R6d7aA2gXW3O1ck9pX%2BjFul0YCsTAlKFCeqzv8aof7YNuyS%2FjXfPg2QXDzgftR2I1X11trsj8DIitfd0R1kE%2BWScXRNlriCbE7M%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: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Response
200Body
{
"code": "OK",
"data": {
"id": "7846d6aa-4288-44fb-8672-c4deade05f2a",
"created_at": 1791656467.444799,
"updated_at": 1791656467.444799,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c848f00-c4d7-11f1-89da-fb554657817f.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c848f00-c4d7-11f1-89da-fb554657817f.zip?Expires=1791742867446&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=h4qJRYj2DsA~npqYyTSqtH2AleBEAPStiOBrtvxj1oaSCqBf9jc5BWXW-WfQaQvbCZ7B5xsgxCSxr1Kxk299U6D08IrxS0v-VUImuCQBtH6yOYZcj4ZBy8e4UvcUjcK-7Z9kgiZkePyyKXG-Hk65IfZGNduH77kJAECWmYfzcS-GyytLjC9UX4~F2mGSXrh897FZWDMO~gjGUTjhdFEiduenzSD6Od2J~t-Mohc9op3QeuXeRt~3xIRlODBWTNUTmZm-ZFxFus~Lj18210j7dAe~JtjfO~c~a1LJmceFOvoMBZhSNbXH5JDWvPUXN3GKbkAXT41XxRxqSlqjHE3pSA__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}Download the deal history file ¶
Download the deal history fileGET/deals/:id/history.pdf
Example URI
GET /deals/:id/history.pdf
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Response
200Body
{
"code": "OK",
"data": {
"id": "a97f0b93-4286-4a2a-bda6-1fbba6ddb56e",
"created_at": 1791656467.466209,
"updated_at": 1791656467.466209,
"deleted_at": null,
"created_by": null,
"path": "deals/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c885f90-c4d7-11f1-89da-fb554657817f.pdf",
"name": "History.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/deals/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c885f90-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742867467&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=RWQAzWo0hBDdObR8V44Ck-Cc2qjPf~HCgV8gq0wHwznr-8eCawGDFgvrzO-PtZYN7~nnTdp0c0Rw~ax0Xkm9Y27tNlcT~gq0UgmjixdrW43xOYexXabiXHhrTyu18XSc7bSOGJ1LC5rz3B-9NNV2o3JTUFm3S~L-02WYOOjY6FhE9aHKj3FdUDO9gW1FBEHaXyYNeDCBYRx~DxkVIkJlqxnOTjpGkl6ZXe~iOTjmDZZf2PaksLaEPFUkOH9Q2cHYKPPke33MhCneo8FCGYv6lt5KhCMlncljEfJnfV~X73wU4cpmAl7qMkj-EIDlgswTyXKEynUMlQqh5dSVc0hnuA__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}Download the deal summary file ¶
Download the deal summary fileGET/deals/:id/summary.pdf
Example URI
GET /deals/:id/summary.pdf
URI Parameters
- id
string(required) Example: b38a9f39-58dd-44fb-93fb-7beccad10fa2
Response
200Body
{
"code": "OK",
"data": {
"id": "395a817c-0d4b-4232-b9ef-868139a5b131",
"created_at": 1791656467.534357,
"updated_at": 1791656467.534357,
"deleted_at": null,
"created_by": null,
"path": "deals/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c92bfd0-c4d7-11f1-89da-fb554657817f.pdf",
"name": "Summary.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/deals/b38a9f39-58dd-44fb-93fb-7beccad10fa2/5c92bfd0-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742867535&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Z514bOI6r0mZ6HRlfPefHjEo53JvX~yJsBFPcimOChQ1OhE59W3F3-pEUGpsEHSH7WQbmODRaFAwZgEi7iAC-WlfoyPEX2GdUmBL5yMjciDFxGZs7cWOwVjeN0beQOTu4dvDsP0vT1o8CayRgSvSiNTF~E8TDFQz54WqT0N2Qj9tQHU-fUqMm1HEu9cOWs0q4M1Ptrsr7EDcx06B~c756dgWSFeQjWRVrmrUaZ1MWdpasY6QezNgs-cP5cBPuL5S4rVE6qqeWBq6IB3gUZh~q6iJeb5~UhjxehndrsWxBGyAFcs3XOKF9PZqcDoBcKqKTunBc7bjWZUeTrzETxFtgw__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}