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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Response
200Body
{
"code": "OK",
"data": {
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-11T11:57:26.473Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "39851061-d5ab-4bda-aa95-bd53272153fd",
"created_at": 1786449446.575722,
"updated_at": 1786449446.575722,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "SellerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "e99ceab2-f622-4d6a-a8af-2f37ed850e68",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "8dbc58c0-21de-40f3-8c31-95c2c74b589c",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "9483d600-5ad1-4a96-8f75-46dc09fb672d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "40c70913-efee-4c86-9f1d-b07c0bc2f0dc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6ee757f4-3834-4e7b-986e-ebc70b4cfa8b",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "f2e3c18a-a0ca-4d41-a2d4-6971738a77a0",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "516d8112-4ea9-4829-af81-8660c69f5d29",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "25588980-f5c3-4dfe-be2c-dd47a20ece2f",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6986a5a7-0a57-4ae5-ba5b-564c4c0d06fe",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "99574831-fb44-442a-8738-7e1f4912712d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "77604d83-8f4c-42ec-9c63-08aab7f98c2e",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "513103bf-72a7-44d0-9ed3-c3b22529d5d1",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "82c76e98-7c29-42e2-b3aa-425a37bce56d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "39e3634d-b143-4555-9a52-429e56c41249",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "bf05472f-a521-42df-b58f-a7c7b15121af",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa6022a9-8d77-48c3-80f2-71e42e7ecc32",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "d5be26ca-d265-448e-a31b-c1fb5742b54c",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "ff3ded7f-43f8-452d-a778-f69f511d718d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "1e57a4cf-7a99-444f-ab91-1ebcd02ed397",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa1fe10f-ccd7-428a-9e58-3c871a48a2d4",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "491f7809-f82a-4c10-adca-adf55a14cedc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-11T11:57:26.473Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "39851061-d5ab-4bda-aa95-bd53272153fd",
"created_at": 1786449446.575722,
"updated_at": 1786449446.575722,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "SellerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "e99ceab2-f622-4d6a-a8af-2f37ed850e68",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "8dbc58c0-21de-40f3-8c31-95c2c74b589c",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "9483d600-5ad1-4a96-8f75-46dc09fb672d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "40c70913-efee-4c86-9f1d-b07c0bc2f0dc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6ee757f4-3834-4e7b-986e-ebc70b4cfa8b",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "f2e3c18a-a0ca-4d41-a2d4-6971738a77a0",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "516d8112-4ea9-4829-af81-8660c69f5d29",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "25588980-f5c3-4dfe-be2c-dd47a20ece2f",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6986a5a7-0a57-4ae5-ba5b-564c4c0d06fe",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "99574831-fb44-442a-8738-7e1f4912712d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "77604d83-8f4c-42ec-9c63-08aab7f98c2e",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "513103bf-72a7-44d0-9ed3-c3b22529d5d1",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "82c76e98-7c29-42e2-b3aa-425a37bce56d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "39e3634d-b143-4555-9a52-429e56c41249",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "bf05472f-a521-42df-b58f-a7c7b15121af",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa6022a9-8d77-48c3-80f2-71e42e7ecc32",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "d5be26ca-d265-448e-a31b-c1fb5742b54c",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "ff3ded7f-43f8-452d-a778-f69f511d718d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "1e57a4cf-7a99-444f-ab91-1ebcd02ed397",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa1fe10f-ccd7-428a-9e58-3c871a48a2d4",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "491f7809-f82a-4c10-adca-adf55a14cedc",
"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: 578d5aa4-3a19-4793-8ea3-69979ad65e89
Response
200Body
{
"code": "OK",
"data": [
{
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-11T11:57:26.473Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "39851061-d5ab-4bda-aa95-bd53272153fd",
"created_at": 1786449446.575722,
"updated_at": 1786449446.575722,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "SellerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "e99ceab2-f622-4d6a-a8af-2f37ed850e68",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "8dbc58c0-21de-40f3-8c31-95c2c74b589c",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "9483d600-5ad1-4a96-8f75-46dc09fb672d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "40c70913-efee-4c86-9f1d-b07c0bc2f0dc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6ee757f4-3834-4e7b-986e-ebc70b4cfa8b",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "f2e3c18a-a0ca-4d41-a2d4-6971738a77a0",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "516d8112-4ea9-4829-af81-8660c69f5d29",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "25588980-f5c3-4dfe-be2c-dd47a20ece2f",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6986a5a7-0a57-4ae5-ba5b-564c4c0d06fe",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "99574831-fb44-442a-8738-7e1f4912712d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "77604d83-8f4c-42ec-9c63-08aab7f98c2e",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "513103bf-72a7-44d0-9ed3-c3b22529d5d1",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "82c76e98-7c29-42e2-b3aa-425a37bce56d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "39e3634d-b143-4555-9a52-429e56c41249",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "bf05472f-a521-42df-b58f-a7c7b15121af",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa6022a9-8d77-48c3-80f2-71e42e7ecc32",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "d5be26ca-d265-448e-a31b-c1fb5742b54c",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "ff3ded7f-43f8-452d-a778-f69f511d718d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "1e57a4cf-7a99-444f-ab91-1ebcd02ed397",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa1fe10f-ccd7-428a-9e58-3c871a48a2d4",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "491f7809-f82a-4c10-adca-adf55a14cedc",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"attention_requests": 0,
"has_active_offer": true,
"email": "[email protected]"
}
],
"info": {
"count": 1,
"total": 2
}
}Get all deals that need backoffice review ¶
Get all deals that need backoffice reviewGET/brands/:brand/deals/inbox
Example URI
GET /brands/:brand/deals/inbox
URI Parameters
- brand
string(required) Example: 578d5aa4-3a19-4793-8ea3-69979ad65e89- associations
string(required) Example: deal.inboxes
Response
200Body
{
"code": "OK",
"data": [
{
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-11T11:57:26.473Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": 1786449450.937749,
"is_draft": false,
"roles": [
{
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "39851061-d5ab-4bda-aa95-bd53272153fd",
"created_at": 1786449446.575722,
"updated_at": 1786449446.575722,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "SellerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "e99ceab2-f622-4d6a-a8af-2f37ed850e68",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "8dbc58c0-21de-40f3-8c31-95c2c74b589c",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "9483d600-5ad1-4a96-8f75-46dc09fb672d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "40c70913-efee-4c86-9f1d-b07c0bc2f0dc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6ee757f4-3834-4e7b-986e-ebc70b4cfa8b",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "f2e3c18a-a0ca-4d41-a2d4-6971738a77a0",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "516d8112-4ea9-4829-af81-8660c69f5d29",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "25588980-f5c3-4dfe-be2c-dd47a20ece2f",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6986a5a7-0a57-4ae5-ba5b-564c4c0d06fe",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "99574831-fb44-442a-8738-7e1f4912712d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "77604d83-8f4c-42ec-9c63-08aab7f98c2e",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "513103bf-72a7-44d0-9ed3-c3b22529d5d1",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "82c76e98-7c29-42e2-b3aa-425a37bce56d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "39e3634d-b143-4555-9a52-429e56c41249",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "bf05472f-a521-42df-b58f-a7c7b15121af",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa6022a9-8d77-48c3-80f2-71e42e7ecc32",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "d5be26ca-d265-448e-a31b-c1fb5742b54c",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "ff3ded7f-43f8-452d-a778-f69f511d718d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "1e57a4cf-7a99-444f-ab91-1ebcd02ed397",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa1fe10f-ccd7-428a-9e58-3c871a48a2d4",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "491f7809-f82a-4c10-adca-adf55a14cedc",
"searchable": "",
"deleted_at": null
},
"type": "deal_context"
},
"new_notifications": null,
"inboxes": [
{
"id": "d33c1b46-0af9-497f-8bf7-cc19106fbdc7",
"brand": "579cf2b9-626a-4538-95a2-93fc9c92d6bc",
"label": "Contract Inbox",
"created_by": null,
"listing_default": false,
"contract_default": true,
"created_at": 1786449445.410101,
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": "2026-08-11T11:57:26.473Z",
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": false,
"roles": [
{
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
},
{
"id": "39851061-d5ab-4bda-aa95-bd53272153fd",
"created_at": 1786449446.575722,
"updated_at": 1786449446.575722,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "SellerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "e99ceab2-f622-4d6a-a8af-2f37ed850e68",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "8dbc58c0-21de-40f3-8c31-95c2c74b589c",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "9483d600-5ad1-4a96-8f75-46dc09fb672d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "40c70913-efee-4c86-9f1d-b07c0bc2f0dc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6ee757f4-3834-4e7b-986e-ebc70b4cfa8b",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "f2e3c18a-a0ca-4d41-a2d4-6971738a77a0",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "516d8112-4ea9-4829-af81-8660c69f5d29",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "25588980-f5c3-4dfe-be2c-dd47a20ece2f",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6986a5a7-0a57-4ae5-ba5b-564c4c0d06fe",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "99574831-fb44-442a-8738-7e1f4912712d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "77604d83-8f4c-42ec-9c63-08aab7f98c2e",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "513103bf-72a7-44d0-9ed3-c3b22529d5d1",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "82c76e98-7c29-42e2-b3aa-425a37bce56d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "39e3634d-b143-4555-9a52-429e56c41249",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "bf05472f-a521-42df-b58f-a7c7b15121af",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa6022a9-8d77-48c3-80f2-71e42e7ecc32",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "d5be26ca-d265-448e-a31b-c1fb5742b54c",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "ff3ded7f-43f8-452d-a778-f69f511d718d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "1e57a4cf-7a99-444f-ab91-1ebcd02ed397",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa1fe10f-ccd7-428a-9e58-3c871a48a2d4",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "491f7809-f82a-4c10-adca-adf55a14cedc",
"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": "fcef78be-e975-4860-b1cb-ca30f6855450"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"gallery": {
"id": "d1d9556e-957b-11f1-af9d-fa4e231a189a",
"created_at": 1786449445.93934,
"updated_at": 1786449445.93934,
"deleted_at": null,
"type": "gallery",
"items": null
},
"property_type": {
"id": "fcef78be-e975-4860-b1cb-ca30f6855450",
"created_at": 1786449445.644731,
"updated_at": 1786449445.644731,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "1d842066-834f-4411-b822-7e26a44be383",
"created_at": 1786449444.823098,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450",
"checklist_type": "Selling",
"inbox": "de79a835-79f1-40d2-877f-5f568df7808c",
"type": "brand_checklist",
"tasks": null
},
{
"id": "955a721a-9ba8-49ab-b5b3-7118c88e73c9",
"created_at": 1786449444.823098,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450",
"checklist_type": "Buying",
"inbox": "d33c1b46-0af9-497f-8bf7-cc19106fbdc7",
"type": "brand_checklist",
"tasks": null
},
{
"id": "b0d0fa08-fe5b-4882-a3c1-4e6b1b6d5560",
"created_at": 1786449444.823098,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450",
"checklist_type": "Offer",
"inbox": "d33c1b46-0af9-497f-8bf7-cc19106fbdc7",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
{
"id": "39851061-d5ab-4bda-aa95-bd53272153fd",
"created_at": 1786449446.575722,
"updated_at": 1786449446.575722,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "SellerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"info": {
"count": 2,
"total": 0
}
}Update a role ¶
Update a rolePUT/deals/:id/roles/:rid
Example URI
PUT /deals/:id/roles/:rid
URI Parameters
- id
string(required) Example: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- rid
string(required) Example: 4d33b565-0825-4ef0-a26d-0ee61bd8c0d1
Request
Body
{
"legal_first_name": "Updated Legal Name",
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1"
}Response
200Body
{
"code": "OK",
"data": {
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Updated Legal Name",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':6 'coyot':5 'e':4 'legal':2 'name':3 'updat':1",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Updated Legal Name E. Coyote"
}
}Set listing for a deal ¶
Set listing for a dealPATCH/deals/:id/listing
Example URI
PATCH /deals/:id/listing
URI Parameters
- id
string(required) Example: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Request
Body
{
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "5020 Junius Street",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"city": {
"id": null,
"type": "deal_context_item",
"created_at": null,
"created_by": null,
"approved_by": null,
"approved_at": null,
"key": "city",
"text": "Dallas",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "e99ceab2-f622-4d6a-a8af-2f37ed850e68",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "8dbc58c0-21de-40f3-8c31-95c2c74b589c",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "9483d600-5ad1-4a96-8f75-46dc09fb672d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "40c70913-efee-4c86-9f1d-b07c0bc2f0dc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6ee757f4-3834-4e7b-986e-ebc70b4cfa8b",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "f2e3c18a-a0ca-4d41-a2d4-6971738a77a0",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "516d8112-4ea9-4829-af81-8660c69f5d29",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "25588980-f5c3-4dfe-be2c-dd47a20ece2f",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6986a5a7-0a57-4ae5-ba5b-564c4c0d06fe",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "99574831-fb44-442a-8738-7e1f4912712d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "77604d83-8f4c-42ec-9c63-08aab7f98c2e",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "513103bf-72a7-44d0-9ed3-c3b22529d5d1",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "82c76e98-7c29-42e2-b3aa-425a37bce56d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "39e3634d-b143-4555-9a52-429e56c41249",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "bf05472f-a521-42df-b58f-a7c7b15121af",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa6022a9-8d77-48c3-80f2-71e42e7ecc32",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "d5be26ca-d265-448e-a31b-c1fb5742b54c",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "ff3ded7f-43f8-452d-a778-f69f511d718d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "1e57a4cf-7a99-444f-ab91-1ebcd02ed397",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa1fe10f-ccd7-428a-9e58-3c871a48a2d4",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "491f7809-f82a-4c10-adca-adf55a14cedc",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- associations
string(required) Example: deal.property_type
Request
Body
{
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450"
}Response
200Body
{
"code": "OK",
"data": {
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "5020 Junius Street",
"property_type": {
"id": "fcef78be-e975-4860-b1cb-ca30f6855450",
"created_at": 1786449445.644731,
"updated_at": 1786449445.644731,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "1d842066-834f-4411-b822-7e26a44be383",
"created_at": 1786449444.823098,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"title": "Listing",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450",
"checklist_type": "Selling",
"inbox": "de79a835-79f1-40d2-877f-5f568df7808c",
"type": "brand_checklist",
"tasks": null
},
{
"id": "955a721a-9ba8-49ab-b5b3-7118c88e73c9",
"created_at": 1786449444.823098,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"title": "Contract",
"order": 0,
"is_terminatable": false,
"tab_name": null,
"is_deactivatable": false,
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450",
"checklist_type": "Buying",
"inbox": "d33c1b46-0af9-497f-8bf7-cc19106fbdc7",
"type": "brand_checklist",
"tasks": null
},
{
"id": "b0d0fa08-fe5b-4882-a3c1-4e6b1b6d5560",
"created_at": 1786449444.823098,
"deleted_at": null,
"brand": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"title": "Checklist 1",
"order": 2,
"is_terminatable": true,
"tab_name": null,
"is_deactivatable": true,
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450",
"checklist_type": "Offer",
"inbox": "d33c1b46-0af9-497f-8bf7-cc19106fbdc7",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "e99ceab2-f622-4d6a-a8af-2f37ed850e68",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "8dbc58c0-21de-40f3-8c31-95c2c74b589c",
"searchable": "'dalla':1",
"deleted_at": null
},
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "9483d600-5ad1-4a96-8f75-46dc09fb672d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "40c70913-efee-4c86-9f1d-b07c0bc2f0dc",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6ee757f4-3834-4e7b-986e-ebc70b4cfa8b",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "f2e3c18a-a0ca-4d41-a2d4-6971738a77a0",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "516d8112-4ea9-4829-af81-8660c69f5d29",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "25588980-f5c3-4dfe-be2c-dd47a20ece2f",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "6986a5a7-0a57-4ae5-ba5b-564c4c0d06fe",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "99574831-fb44-442a-8738-7e1f4912712d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "77604d83-8f4c-42ec-9c63-08aab7f98c2e",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "513103bf-72a7-44d0-9ed3-c3b22529d5d1",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "82c76e98-7c29-42e2-b3aa-425a37bce56d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "39e3634d-b143-4555-9a52-429e56c41249",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "bf05472f-a521-42df-b58f-a7c7b15121af",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa6022a9-8d77-48c3-80f2-71e42e7ecc32",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "d5be26ca-d265-448e-a31b-c1fb5742b54c",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "ff3ded7f-43f8-452d-a778-f69f511d718d",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "1e57a4cf-7a99-444f-ab91-1ebcd02ed397",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "aa1fe10f-ccd7-428a-9e58-3c871a48a2d4",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "MLS",
"definition": "491f7809-f82a-4c10-adca-adf55a14cedc",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Request
Body
{
"context": [
{
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"value": "2017/12/06"
},
{
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"value": "Conventional"
}
]
}Response
200Body
{
"code": "OK",
"data": {
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- cid
string(required) Example: 5648690c-b4cd-4b1a-abd1-873f394e62b5
Request
Body
{
"approved": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_at": 1786449445.939243,
"updated_at": 1786449445.939243,
"deleted_at": null,
"listing": null,
"deal_type": "Buying",
"brokerwolf_tier_id": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"number": 6,
"faired_at": null,
"title": "[Draft]",
"type": "deal",
"attention_requested_at": null,
"is_draft": true,
"roles": null,
"context": {
"financing_type": {
"id": "b72871ea-711c-4fce-88b4-0541c972a32e",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": null,
"approved_at": null,
"key": "financing_type",
"text": "Conventional",
"number": null,
"date": null,
"data_type": "Text",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "fa3cdc3f-1df5-4754-a6ca-5f4535582acb",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": null,
"source": "PropertyType",
"definition": "7dbdbf06-6476-4275-a081-b18f08811985",
"searchable": "'leas':2 'residenti':1",
"deleted_at": null
},
"review_date": {
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": "2026-08-11T11:57:24.823098+00:00",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"approved_at": "2026-08-11T11:57:26.194687+00:00",
"key": "review_date",
"text": "2017/12/06",
"number": null,
"date": 1512518400,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"source": "Provided",
"definition": "d1e20aba-9a49-4e26-a0e9-781c36c7a2f3",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- cname
string(required) Example: review_date
Response
200Body
{
"code": "OK",
"data": [
{
"id": "5648690c-b4cd-4b1a-abd1-873f394e62b5",
"type": "deal_context_item",
"created_at": 1786449444.823098,
"approved_at": 1786449446.194687,
"date": 1512518400,
"key": "review_date",
"text": "2017/12/06",
"number": null,
"data_type": "Date",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745"
}
],
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81"
},
{
"legal_first_name": "Imaginary",
"legal_last_name": "Agent",
"email": "[email protected]",
"role": "SellerAgent",
"commission_dollar": 20000,
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81"
}
]
}Response
200Body
{
"code": "OK",
"data": [
{
"id": "4d33b565-0825-4ef0-a26d-0ee61bd8c0d1",
"created_at": 1786449446.571142,
"updated_at": 1786449446.571142,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "BuyerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
{
"id": "39851061-d5ab-4bda-aa95-bd53272153fd",
"created_at": 1786449446.575722,
"updated_at": 1786449446.575722,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"role": "SellerAgent",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": null,
"last_seen_type": null,
"active_brand": null,
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
}
],
"info": {
"count": 2,
"total": 0
}
}Delete a role ¶
Delete a roleDELETE/deals/:id/roles/:rid
Example URI
DELETE /deals/:id/roles/:rid
URI Parameters
- id
string(required) Example: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- rid
string(required) Example: 4d33b565-0825-4ef0-a26d-0ee61bd8c0d1
Response
204Add new checklist ¶
Add new checklistPOST/deals/:id/checklists
Example URI
POST /deals/:id/checklists
URI Parameters
- id
string(required) Example: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Request
Body
{
"checklist": {
"title": "Offered Checklist",
"order": 1,
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4"
},
"conditions": {
"checklist_type": "Offer",
"property_type": "fcef78be-e975-4860-b1cb-ca30f6855450"
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"created_at": 1786449444.823098,
"updated_at": 1786449444.823098,
"deleted_at": null,
"deactivated_at": null,
"title": "Offered Checklist",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"order": 1,
"origin": "b0d0fa08-fe5b-4882-a3c1-4e6b1b6d5560",
"terminated_at": null,
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": false,
"is_terminated": false,
"tasks": null,
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"inbox": "d33c1b46-0af9-497f-8bf7-cc19106fbdc7",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- cid
string(required) Example: 72c54d02-b6a4-438f-883a-d2819c8f9745
Request
Body
{
"title": "Updated Checklist 1",
"order": 3,
"is_deactivated": true,
"is_terminated": true,
"id": "72c54d02-b6a4-438f-883a-d2819c8f9745"
}Response
200Body
{
"code": "OK",
"data": {
"id": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"created_at": 1786449444.823098,
"updated_at": 1786449444.823098,
"deleted_at": null,
"deactivated_at": "2026-08-11T11:57:31.329Z",
"title": "Updated Checklist 1",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"order": 3,
"origin": "b0d0fa08-fe5b-4882-a3c1-4e6b1b6d5560",
"terminated_at": "2026-08-11T11:57:31.329Z",
"faired_at": null,
"type": "deal_checklist",
"is_deactivated": true,
"is_terminated": true,
"tasks": [
{
"id": "dd14b83f-0608-433d-a6ec-aadc1e875b13",
"created_at": 1786449447.305703,
"updated_at": 1786449451.188709,
"room": {
"type": "room",
"id": "a2feb716-e7d5-4bcd-a020-97aab83d4f48",
"title": "5020 Junius Street: Test Title",
"created_at": 1786449447.29362,
"updated_at": 1786449450.896466,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "def850dd-7269-4568-a660-5374281d1813",
"last_revision": "b9b0f6f9-a610-4bd9-96d4-2d60e65c493f",
"state": "Fair",
"created_at": 1786449449.195933,
"updated_at": 1786449449.853584,
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"formstack_id": null,
"author": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "32eb77b3-60f6-4c00-a557-e157b6bddd15",
"created_at": 1786449449.883714,
"updated_at": 1786449449.883714,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf?Expires=1786535849888&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=bZqeB36cE4GB8u-6G0fzF4kgNv~7ZMqBlc6zwQUHrs4DRGxiZ5mOrzIWyKf3hNOocJVXAJP7uNaAstKyr6OhYKd1Z9-DhfpbQa0m7~vKBa~VfyxuklFI9TsuZPcCWKD5bXzMcD3~dThOnUF1DLMOvd-mOC5rpK5z6eJzg1XChEjeqHj-9uQhEBWfAKr3uDbN9ATAT-b0tIah0qGWmL6UP3JY~IVOJvpH6EfM8j4GZCjvElh3WPCzUeb33MvgxymgOLUtI4r-VQgOcUh0fY-Cw44rsPU5cY-nijvajrht2Sgm5vl50qUfNxmu2iH0Mbr~LWLwA~juzoezn5oJiC4n-w__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "b51b6951-7e8b-47d3-8e0f-bac738dfbc42",
"created_at": 1786449450.409012,
"type": "review",
"status": "Declined",
"updated_at": 1786449450.412618
},
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/submission.pdf?hash=jFzZqXtHACj1j9mCRzF7V6prhrydLBmLXjUOY9xUZHHEWiUqHYDB4%2BdKyy8TB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX6jAu1xf0IATg%3D%3D"
}
],
"is_deactivatable": true,
"is_terminatable": true,
"checklist_type": "Offer",
"inbox": "d33c1b46-0af9-497f-8bf7-cc19106fbdc7",
"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: dd14b83f-0608-433d-a6ec-aadc1e875b13
Response
200Body
{
"code": "OK",
"data": {
"id": "dd14b83f-0608-433d-a6ec-aadc1e875b13",
"created_at": 1786449447.305703,
"updated_at": 1786449449.256595,
"room": {
"type": "room",
"id": "a2feb716-e7d5-4bcd-a020-97aab83d4f48",
"title": "5020 Junius Street: Test Title",
"created_at": 1786449447.29362,
"updated_at": 1786449450.131805,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "def850dd-7269-4568-a660-5374281d1813",
"last_revision": "b9b0f6f9-a610-4bd9-96d4-2d60e65c493f",
"state": "Fair",
"created_at": 1786449449.195933,
"updated_at": 1786449449.853584,
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"formstack_id": null,
"author": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "32eb77b3-60f6-4c00-a557-e157b6bddd15",
"created_at": 1786449449.883714,
"updated_at": 1786449449.883714,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf?Expires=1786535849888&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=bZqeB36cE4GB8u-6G0fzF4kgNv~7ZMqBlc6zwQUHrs4DRGxiZ5mOrzIWyKf3hNOocJVXAJP7uNaAstKyr6OhYKd1Z9-DhfpbQa0m7~vKBa~VfyxuklFI9TsuZPcCWKD5bXzMcD3~dThOnUF1DLMOvd-mOC5rpK5z6eJzg1XChEjeqHj-9uQhEBWfAKr3uDbN9ATAT-b0tIah0qGWmL6UP3JY~IVOJvpH6EfM8j4GZCjvElh3WPCzUeb33MvgxymgOLUtI4r-VQgOcUh0fY-Cw44rsPU5cY-nijvajrht2Sgm5vl50qUfNxmu2iH0Mbr~LWLwA~juzoezn5oJiC4n-w__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": null,
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/submission.pdf?hash=jFzZqXtHACj1j9mCRzF7V6prhrydLBmLXjUOY9xUZHHEWiUqHYDB4%2BdKyy8TB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX6iAupxf0IATg%3D%3D"
}
}Add a task ¶
Add a taskPOST/deals/:id/tasks
Example URI
POST /deals/:id/tasks
URI Parameters
- id
string(required) Example: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Request
Body
{
"title": "Test Title",
"status": "New",
"task_type": "Form",
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"is_deletable": true,
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"room": "a2feb716-e7d5-4bcd-a020-97aab83d4f48"
}Response
200Body
{
"code": "OK",
"data": {
"id": "dd14b83f-0608-433d-a6ec-aadc1e875b13",
"created_at": 1786449447.305703,
"updated_at": 1786449447.305703,
"room": {
"type": "room",
"id": "a2feb716-e7d5-4bcd-a020-97aab83d4f48",
"title": "5020 Junius Street: Test Title",
"created_at": 1786449447.29362,
"updated_at": 1786449447.380091,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/submission.pdf?hash=jFzZqXtHACj1j9mCRzF7V6prhrydLBmLXjUOY9xUZHHEWiUqHYDB4%2BdKyy8TB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX%2BlAu17eEIATg%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: dd14b83f-0608-433d-a6ec-aadc1e875b13
Request
Body
{
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"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": "def850dd-7269-4568-a660-5374281d1813",
"last_revision": "c1cecb34-19dd-43eb-adeb-5830e804c75e",
"state": "Fair",
"created_at": 1786449449.195933,
"updated_at": 1786449449.505419,
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"formstack_id": null,
"author": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "e9f004a1-e771-4ed5-ab25-d28fa48a82a9",
"created_at": 1786449449.53557,
"updated_at": 1786449449.53557,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d3faa190-957b-11f1-8005-55e627762063.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d3faa190-957b-11f1-8005-55e627762063.pdf?Expires=1786535849540&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=f8gmUAuYuKGFpj6~~JCxG3Bbd-sgZcfdifR8ifvRonuctbJwRx6gB5aL28RjIV0chN9cmd1wHBNYFHBrgLP-YJ2x59uMLunuHRBiCVUCOypNphG11NPVA2WiFqL8sclKwKv5kbSOsiEyMmKj3lBtxs9dAPYFuZC-T78jzzyWS-aEaBnHURU3zlPJnWCgwlp9eNFGiQgfqPoBn-2-2FHkIl10v2-g024-PndWHwI0YCoiN~d5g9HQJnWCgWGkkrua80~CLjofzD6g0w6SxP90dkw0Kt4daoakXBcWcWBviyOX-7RzsZXnswb3rvN6Soo-OZzJ64FNB6yMMt3~Oj-Fhw__",
"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: dd14b83f-0608-433d-a6ec-aadc1e875b13- revision
string(required) Example: c1cecb34-19dd-43eb-adeb-5830e804c75e
Response
200Body
{
"code": "OK",
"data": {
"id": "c1cecb34-19dd-43eb-adeb-5830e804c75e",
"submission": "def850dd-7269-4568-a660-5374281d1813",
"created_at": 1786449449.195933,
"updated_at": 1786449449.505419,
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"author": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"values": {
"Form1": "11112 New Orleans Drive"
},
"state": "Fair",
"type": "form_revision",
"file": "e9f004a1-e771-4ed5-ab25-d28fa48a82a9"
}
}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: dd14b83f-0608-433d-a6ec-aadc1e875b13
Request
Body
{
"status": "Declined",
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81"
}Response
200Body
{
"code": "OK",
"data": {
"id": "dd14b83f-0608-433d-a6ec-aadc1e875b13",
"created_at": 1786449447.305703,
"updated_at": 1786449450.42197,
"room": {
"type": "room",
"id": "a2feb716-e7d5-4bcd-a020-97aab83d4f48",
"title": "5020 Junius Street: Test Title",
"created_at": 1786449447.29362,
"updated_at": 1786449450.466707,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "def850dd-7269-4568-a660-5374281d1813",
"last_revision": "b9b0f6f9-a610-4bd9-96d4-2d60e65c493f",
"state": "Fair",
"created_at": 1786449449.195933,
"updated_at": 1786449449.853584,
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"formstack_id": null,
"author": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "32eb77b3-60f6-4c00-a557-e157b6bddd15",
"created_at": 1786449449.883714,
"updated_at": 1786449449.883714,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf?Expires=1786535849888&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=bZqeB36cE4GB8u-6G0fzF4kgNv~7ZMqBlc6zwQUHrs4DRGxiZ5mOrzIWyKf3hNOocJVXAJP7uNaAstKyr6OhYKd1Z9-DhfpbQa0m7~vKBa~VfyxuklFI9TsuZPcCWKD5bXzMcD3~dThOnUF1DLMOvd-mOC5rpK5z6eJzg1XChEjeqHj-9uQhEBWfAKr3uDbN9ATAT-b0tIah0qGWmL6UP3JY~IVOJvpH6EfM8j4GZCjvElh3WPCzUeb33MvgxymgOLUtI4r-VQgOcUh0fY-Cw44rsPU5cY-nijvajrht2Sgm5vl50qUfNxmu2iH0Mbr~LWLwA~juzoezn5oJiC4n-w__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "b51b6951-7e8b-47d3-8e0f-bac738dfbc42",
"created_at": 1786449450.409012,
"type": "review",
"status": "Declined",
"updated_at": 1786449450.412618
},
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/submission.pdf?hash=jFzZqXtHACj1j9mCRzF7V6prhrydLBmLXjUOY9xUZHHEWiUqHYDB4%2BdKyy8TB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX6iAux6e0IATg%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: dd14b83f-0608-433d-a6ec-aadc1e875b13
Request
Body
{
"attention_requested": true
}Response
200Body
{
"code": "OK",
"data": {
"id": "dd14b83f-0608-433d-a6ec-aadc1e875b13",
"created_at": 1786449447.305703,
"updated_at": 1786449450.937749,
"room": {
"type": "room",
"id": "a2feb716-e7d5-4bcd-a020-97aab83d4f48",
"title": "5020 Junius Street: Test Title",
"created_at": 1786449447.29362,
"updated_at": 1786449450.896466,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "def850dd-7269-4568-a660-5374281d1813",
"last_revision": "b9b0f6f9-a610-4bd9-96d4-2d60e65c493f",
"state": "Fair",
"created_at": 1786449449.195933,
"updated_at": 1786449449.853584,
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"formstack_id": null,
"author": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"title": "Addendum for Back-Up Contract",
"type": "form_submission",
"file": {
"id": "32eb77b3-60f6-4c00-a557-e157b6bddd15",
"created_at": 1786449449.883714,
"updated_at": 1786449449.883714,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d42fbb50-957b-11f1-8005-55e627762063.pdf?Expires=1786535849888&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=bZqeB36cE4GB8u-6G0fzF4kgNv~7ZMqBlc6zwQUHrs4DRGxiZ5mOrzIWyKf3hNOocJVXAJP7uNaAstKyr6OhYKd1Z9-DhfpbQa0m7~vKBa~VfyxuklFI9TsuZPcCWKD5bXzMcD3~dThOnUF1DLMOvd-mOC5rpK5z6eJzg1XChEjeqHj-9uQhEBWfAKr3uDbN9ATAT-b0tIah0qGWmL6UP3JY~IVOJvpH6EfM8j4GZCjvElh3WPCzUeb33MvgxymgOLUtI4r-VQgOcUh0fY-Cw44rsPU5cY-nijvajrht2Sgm5vl50qUfNxmu2iH0Mbr~LWLwA~juzoezn5oJiC4n-w__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
},
"revision_count": 3
},
"review": {
"id": "b51b6951-7e8b-47d3-8e0f-bac738dfbc42",
"created_at": 1786449450.409012,
"type": "review",
"status": "Declined",
"updated_at": 1786449450.412618
},
"form": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"deleted_at": null,
"is_deletable": true,
"attention_requested_at": "2026-08-11T11:57:30.937Z",
"required": true,
"origin": null,
"order": 2,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/submission.pdf?hash=jFzZqXtHACj1j9mCRzF7V6prhrydLBmLXjUOY9xUZHHEWiUqHYDB4%2BdKyy8TB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX6iAuB7d0IATg%3D%3D"
}
}Update a task ¶
Update a taskPATCH/tasks/:task
Example URI
PATCH /tasks/:task
URI Parameters
- task
string(required) Example: eeac5a99-9642-4db1-97d3-57d2130ab723
Request
Body
{
"title": "Another Task for Gholi",
"required": false
}Response
200Body
{
"code": "OK",
"data": {
"id": "eeac5a99-9642-4db1-97d3-57d2130ab723",
"created_at": 1786449447.54946,
"updated_at": 1786449448.014039,
"room": {
"type": "room",
"id": "346a4644-d9f4-4dff-8ced-ff24d0772c0e",
"title": "5020 Junius Street: Another Task",
"created_at": 1786449447.539402,
"updated_at": 1786449447.613354,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/eeac5a99-9642-4db1-97d3-57d2130ab723/submission.pdf?hash=jFzZqXtHACj1jtjSEGYiXfVrj7yZJhmLCWRbY4RVZSHEDnMqTICX67EdniwTB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX%2BqAul1fUIATg%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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Request
Body
[
{
"id": "dd14b83f-0608-433d-a6ec-aadc1e875b13",
"title": "Bulk Test Title"
},
{
"id": "eeac5a99-9642-4db1-97d3-57d2130ab723",
"attention_requested": true
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "dd14b83f-0608-433d-a6ec-aadc1e875b13",
"created_at": 1786449447.305703,
"updated_at": 1786449448.127504,
"room": {
"type": "room",
"id": "a2feb716-e7d5-4bcd-a020-97aab83d4f48",
"title": "5020 Junius Street: Test Title",
"created_at": 1786449447.29362,
"updated_at": 1786449447.880581,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"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": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": false,
"pdf_url": "http://localhost:3079/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/submission.pdf?hash=jFzZqXtHACj1j9mCRzF7V6prhrydLBmLXjUOY9xUZHHEWiUqHYDB4%2BdKyy8TB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX%2BqAup2fEIATg%3D%3D"
},
{
"id": "eeac5a99-9642-4db1-97d3-57d2130ab723",
"created_at": 1786449447.54946,
"updated_at": 1786449448.242607,
"room": {
"type": "room",
"id": "346a4644-d9f4-4dff-8ced-ff24d0772c0e",
"title": "5020 Junius Street: Another Task",
"created_at": 1786449447.539402,
"updated_at": 1786449448.186613,
"deleted_at": null,
"room_type": "Task",
"new_notifications": 0,
"notification_settings": {
"ec968053-9fef-49b7-b868-f7daddc5cc81": "N_MENTIONS"
},
"users": [
{
"type": "user",
"username": null,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone_number": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"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": "92b0bc76-4db5-4a8a-8bc3-47c5f2df2e7f",
"checklist": "72c54d02-b6a4-438f-883a-d2819c8f9745",
"deleted_at": null,
"is_deletable": false,
"attention_requested_at": "2026-08-11T11:57:28.242Z",
"required": false,
"origin": null,
"order": 0,
"acl": [
"BackOffice",
"Agents"
],
"skyslope_form": null,
"type": "task",
"deal": "5fba15ac-eb0a-4041-bad4-26fec8011ae4",
"attention_requested": true,
"pdf_url": "http://localhost:3079/tasks/eeac5a99-9642-4db1-97d3-57d2130ab723/submission.pdf?hash=jFzZqXtHACj1jtjSEGYiXfVrj7yZJhmLCWRbY4RVZSHEDnMqTICX67EdniwTB2inxE%2BVOb1Ni5YaE6tL5UHnmhyVF%2B0Ccp5dlAHutUw9ZwpxypHhi3dpfwxvbqoeYPGdRmKCTXNE1lZyWqV1aA2hJG3Pu80ypX%2BqAup2fEIATg%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: dd14b83f-0608-433d-a6ec-aadc1e875b13
Request
Body
{
"action": "UserViewedFile",
"object_class": "file",
"object": "e9f004a1-e771-4ed5-ab25-d28fa48a82a9"
}Response
200Body
{
"code": "OK",
"data": {
"id": "fc686975-73fb-45df-b41e-d93832488f60",
"reference": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"reference_type": "User",
"created_at": 1786449450.108721,
"updated_at": 1786449450.108721,
"deleted_at": null,
"object": {
"id": "e9f004a1-e771-4ed5-ab25-d28fa48a82a9",
"created_at": 1786449449.53557,
"updated_at": 1786449449.53557,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d3faa190-957b-11f1-8005-55e627762063.pdf",
"name": "Addendum for Back-Up Contract.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/tasks/dd14b83f-0608-433d-a6ec-aadc1e875b13/d3faa190-957b-11f1-8005-55e627762063.pdf?Expires=1786535849540&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=f8gmUAuYuKGFpj6~~JCxG3Bbd-sgZcfdifR8ifvRonuctbJwRx6gB5aL28RjIV0chN9cmd1wHBNYFHBrgLP-YJ2x59uMLunuHRBiCVUCOypNphG11NPVA2WiFqL8sclKwKv5kbSOsiEyMmKj3lBtxs9dAPYFuZC-T78jzzyWS-aEaBnHURU3zlPJnWCgwlp9eNFGiQgfqPoBn-2-2FHkIl10v2-g024-PndWHwI0YCoiN~d5g9HQJnWCgWGkkrua80~CLjofzD6g0w6SxP90dkw0Kt4daoakXBcWcWBviyOX-7RzsZXnswb3rvN6Soo-OZzJ64FNB6yMMt3~Oj-Fhw__",
"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: dd14b83f-0608-433d-a6ec-aadc1e875b13
Request
Body
{
"comment": "Comment",
"author": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"room": "a2feb716-e7d5-4bcd-a020-97aab83d4f48"
}Response
200Body
{
"code": "OK",
"data": {
"type": "message",
"mid": "bd4343b8-e54a-4dfa-8844-245f6579a8ec",
"id": "bd4343b8-e54a-4dfa-8844-245f6579a8ec",
"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": "+17246643230",
"created_at": 1786449444.841588,
"id": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1786449444.823098,
"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": "5054a863-9805-4305-a8f5-fa3e0c09150b",
"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": "6:57 AM - Tuesday Aug 11, 2026",
"push_allowed": false,
"agents": [
{
"id": "58c8d695-0845-47ac-8c42-1e51b6aa32ea",
"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": "1638431729",
"updated_at": 1786449445.011532,
"deleted_at": null,
"created_at": 1786449445.011532,
"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": "578d5aa4-3a19-4793-8ea3-69979ad65e89",
"display_name": "John Doe",
"abbreviated_display_name": "John",
"online_state": "Offline",
"has_password": true
},
"created_at": 1786449451.509418,
"updated_at": 1786449451.509418,
"room": "a2feb716-e7d5-4bcd-a020-97aab83d4f48",
"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: eeac5a99-9642-4db1-97d3-57d2130ab723
Response
204Create gallery item ¶
Create gallery itemPOST/deals/:id/gallery/items
Example URI
POST /deals/:id/gallery/items
URI Parameters
- id
string(required) Example: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Response
200Body
{
"code": "OK",
"data": {
"id": "29064cb7-269e-4312-b9d9-037af468a8b8",
"created_at": 1786449451.995098,
"updated_at": 1786449451.995099,
"deleted_at": null,
"gallery": "d1d9556e-957b-11f1-af9d-fa4e231a189a",
"name": null,
"order": 0,
"file": {
"id": "4d181e7b-60d8-4646-955c-d821eb5b523c",
"created_at": 1786449451.989514,
"updated_at": 1786449451.989514,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "5fba15ac-eb0a-4041-bad4-26fec8011ae4/d573fb20-957b-11f1-8005-55e627762063.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d573fb20-957b-11f1-8005-55e627762063.png",
"preview_url": "https://test.cloudfront.net/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d573fb20-957b-11f1-8005-55e627762063.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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- iid
string(required) Example: 29064cb7-269e-4312-b9d9-037af468a8b8
Request
Body
{
"name": "Updated Name",
"description": "Updated Description",
"order": 2,
"file": "4d181e7b-60d8-4646-955c-d821eb5b523c"
}Response
200Body
{
"code": "OK",
"data": {
"id": "29064cb7-269e-4312-b9d9-037af468a8b8",
"created_at": 1786449451.995098,
"updated_at": 1786449444.823098,
"deleted_at": null,
"gallery": "d1d9556e-957b-11f1-af9d-fa4e231a189a",
"name": "Updated Name",
"order": 2,
"file": {
"id": "4d181e7b-60d8-4646-955c-d821eb5b523c",
"created_at": 1786449451.989514,
"updated_at": 1786449451.989514,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "5fba15ac-eb0a-4041-bad4-26fec8011ae4/d573fb20-957b-11f1-8005-55e627762063.png",
"name": "logo.png",
"public": true,
"type": "file",
"url": "https://test.cloudfront.net/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d573fb20-957b-11f1-8005-55e627762063.png",
"preview_url": "https://test.cloudfront.net/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d573fb20-957b-11f1-8005-55e627762063.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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4- iid
string(required) Example: 29064cb7-269e-4312-b9d9-037af468a8b8
Response
200Body
{
"code": "OK",
"data": {
"id": "29064cb7-269e-4312-b9d9-037af468a8b8",
"created_at": 1786449451.995098,
"updated_at": 1786449444.823098,
"deleted_at": null,
"gallery": "d1d9556e-957b-11f1-af9d-fa4e231a189a",
"name": "Updated Name",
"order": 2,
"file": {
"id": "fa77e846-be20-4394-a9ce-666a594e6bd6",
"created_at": 1786449452.069565,
"updated_at": 1786449452.069565,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5805730-957b-11f1-8005-55e627762063.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5805730-957b-11f1-8005-55e627762063.png?Expires=1786535852072&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=GDQkOTx8nEb1pEI0ge17gMtK32RuUkGmF0GbkBBBoJnGuMLmrFTGjQMKNpsGYjcWMuvDyMJO0h96JN0ytx31eEYvna~MMlc0h1gk1dlCtU4gb9q5ElXKdRMQ-n~TUZJ716nnwigcaJmIvIkMBJGgb6Zmqtv-H1j4sJRcGxHf0uisJ4df5xE16knDRUI7MQXEcuOr9qI-cJTGXZvNGdFWGyUL1QD0X8j8PDekpKfVoXLOsLcKuHEp6CgCz9cHI8V792krydJJU5AqRT71RUFLQcsxoqR3SFKJD53yhUTV6XjnmJIJCqlqvIASVETC5KZiAXE4z~1nUcwSNDwVGbTjlg__",
"preview_url": "https://private-cdn.irish.rechat.com/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5805730-957b-11f1-8005-55e627762063.png?Expires=1786535852072&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=GDQkOTx8nEb1pEI0ge17gMtK32RuUkGmF0GbkBBBoJnGuMLmrFTGjQMKNpsGYjcWMuvDyMJO0h96JN0ytx31eEYvna~MMlc0h1gk1dlCtU4gb9q5ElXKdRMQ-n~TUZJ716nnwigcaJmIvIkMBJGgb6Zmqtv-H1j4sJRcGxHf0uisJ4df5xE16knDRUI7MQXEcuOr9qI-cJTGXZvNGdFWGyUL1QD0X8j8PDekpKfVoXLOsLcKuHEp6CgCz9cHI8V792krydJJU5AqRT71RUFLQcsxoqR3SFKJD53yhUTV6XjnmJIJCqlqvIASVETC5KZiAXE4z~1nUcwSNDwVGbTjlg__",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Request
Body
[
{
"id": "29064cb7-269e-4312-b9d9-037af468a8b8",
"order": 3
}
]Response
200Body
{
"code": "OK",
"data": [
{
"id": "29064cb7-269e-4312-b9d9-037af468a8b8",
"created_at": 1786449451.995098,
"updated_at": 1786449444.823098,
"deleted_at": 1786449444.823098,
"gallery": "d1d9556e-957b-11f1-af9d-fa4e231a189a",
"name": "Updated Name",
"order": 3,
"file": {
"id": "fa77e846-be20-4394-a9ce-666a594e6bd6",
"created_at": 1786449452.069565,
"updated_at": 1786449452.069565,
"deleted_at": null,
"created_by": "ec968053-9fef-49b7-b868-f7daddc5cc81",
"path": "5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5805730-957b-11f1-8005-55e627762063.png",
"name": "logo.png",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5805730-957b-11f1-8005-55e627762063.png?Expires=1786535852072&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=GDQkOTx8nEb1pEI0ge17gMtK32RuUkGmF0GbkBBBoJnGuMLmrFTGjQMKNpsGYjcWMuvDyMJO0h96JN0ytx31eEYvna~MMlc0h1gk1dlCtU4gb9q5ElXKdRMQ-n~TUZJ716nnwigcaJmIvIkMBJGgb6Zmqtv-H1j4sJRcGxHf0uisJ4df5xE16knDRUI7MQXEcuOr9qI-cJTGXZvNGdFWGyUL1QD0X8j8PDekpKfVoXLOsLcKuHEp6CgCz9cHI8V792krydJJU5AqRT71RUFLQcsxoqR3SFKJD53yhUTV6XjnmJIJCqlqvIASVETC5KZiAXE4z~1nUcwSNDwVGbTjlg__",
"preview_url": "https://private-cdn.irish.rechat.com/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5805730-957b-11f1-8005-55e627762063.png?Expires=1786535852072&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=GDQkOTx8nEb1pEI0ge17gMtK32RuUkGmF0GbkBBBoJnGuMLmrFTGjQMKNpsGYjcWMuvDyMJO0h96JN0ytx31eEYvna~MMlc0h1gk1dlCtU4gb9q5ElXKdRMQ-n~TUZJ716nnwigcaJmIvIkMBJGgb6Zmqtv-H1j4sJRcGxHf0uisJ4df5xE16knDRUI7MQXEcuOr9qI-cJTGXZvNGdFWGyUL1QD0X8j8PDekpKfVoXLOsLcKuHEp6CgCz9cHI8V792krydJJU5AqRT71RUFLQcsxoqR3SFKJD53yhUTV6XjnmJIJCqlqvIASVETC5KZiAXE4z~1nUcwSNDwVGbTjlg__",
"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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Request
Body
{
"items": [
"29064cb7-269e-4312-b9d9-037af468a8b8"
]
}Response
200Body
{
"info": {
"url": "http://localhost:3079/gallery/d1d9556e-957b-11f1-af9d-fa4e231a189a.zip?hash=jFzKqWRAR2CuyYeRF2InXflzgO%2BALQGIDytbf9tTLHOPAiBjGNCQvuJMmH8RHX3kkxDSPuwS29FDCPgQ7ELshxDAX7JJI8ESlxXuuldnclp%2Bg5ayi3U4eAxiPOsKc7fQEGPBAzRU3EZ2R6d7aAyoXW3P1ck0pXilFupxYCkbAVKFCeqzv8aof7YNuyS8jHTA0mZNDzhO4BKP1X1y4r8jqz93vPd3EV5SrTLJVEdk%2FiGbE7M%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: 5fba15ac-eb0a-4041-bad4-26fec8011ae4
Response
200Body
{
"code": "OK",
"data": {
"id": "532bd83a-4c88-4798-83e1-96e8cd201be2",
"created_at": 1786449452.413188,
"updated_at": 1786449452.413188,
"deleted_at": null,
"created_by": null,
"path": "temp/deals/archives/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5b39c30-957b-11f1-8005-55e627762063.zip",
"name": "5020 Junius Street.zip",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/temp/deals/archives/5fba15ac-eb0a-4041-bad4-26fec8011ae4/d5b39c30-957b-11f1-8005-55e627762063.zip?Expires=1786535852416&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=JSPx6gnPItG647kmbTDREpTt-HSQCPT185IQZwyxOMlj5MwvDJk6HQL02K4~P28qBDl3-CEoHZ3u-5Iz7K6zJNk~nyKAoFYGncys0BXycFM3QWrFki4rEnJg-kfvYHnS1nfpesrilMZL6~HpeBIUtAfKdE2pyuTRs2HOHN0phwnywinkEq8PjyyFN5Ndb342VUps5cpnZb0sApRR~D2NljI303X2YB0Cth2Jr5BMosjqO0gbFDXjZsBap4ehBmehYpK9kB5XmT14-8-o3~F8D9jdqE6qLPr3DdFImUUEDYoxtgzH0h6vdU87-qu~-z7nqF72FrRogOWQzsH8eSKxrQ__",
"preview_url": "http://assets.rechat.com/mimes/unknown.png",
"mime": "application/zip"
}
}