List Deals

HTTP Request

GEThttps://staging.api-gw.propdata.net/listings/api/v1/deals/

Example Response

{
"count": 0,
"next": "http://www.example.com",
"previous": "http://www.example.com",
"results": [
{
"id": 0,
"tags": [],
"deal": "string",
"site": 0,
"suspensive_conditions": [],
"other_conditions": [],
"selling_agents": "string",
"commission": null,
"model_type": "string",
"meta": {},
"deal_ref": "string",
"created": "2025-07-17T08:32:32.496Z",
"modified": "2025-07-17T08:32:32.496Z",
"deleted": "2025-07-17T08:32:32.496Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"deal_name": "string",
"agent": -2147483648,
"user": -2147483648,
"branch": -2147483648,
"offer": -2147483648,
"business_type": "string",
"status": "string",
"transfer_attorney_instruction_type": "string",
"transfer_attorney": -2147483648,
"transfer_attorney_contacts": [],
"transfer_instruction_status": "string",
"bond_attorney_instruction_type": "string",
"bond_attorney": -2147483648,
"bond_attorney_contacts": [],
"sellers": [],
"seller_notes": "string",
"seller_type": "string",
"buyers": [],
"buyer_notes": "string",
"buyer_type": "string",
"model_id": 0,
"lightstone_id": -2147483648,
"lightstone_data": null,
"property_type": "string",
"location": -2147483648,
"farm_name": "string",
"unit_number": "string",
"street_number": "string",
"street_name": "string",
"complex_name": "string",
"floor_number": "string",
"building_name": "string",
"erf_number": "string",
"share_block_number": "string",
"sectional_scheme_name": "string",
"section_number": "string",
"section_plan_number": "string",
"mandate_type": "string",
"sale_status": "string",
"sale_date": "string",
"expected_transfer_date": "string",
"sale_price": "0.00",
"cash_amount": "0.00",
"deposit_required": false,
"deposit_amount": "0.00",
"deposit_due_date": "string",
"assisted_sale": false,
"sale_bank": "string",
"gas_compliance_required": "string",
"beetle_compliance_required": "string",
"electrical_compliance_required": "string",
"plumbing_compliance_required": "string",
"seller_documents": [],
"buyer_documents": [],
"sale_agreement_documents": [],
"offer_made_date": "string",
"offer_made_notes": "string",
"sale_agreement_date": "string",
"sale_agreement_notes": "string",
"sale_agreement_undertaking_letter": false,
"sale_agreement_undertaking_letter_date": "string",
"sale_agreement_undertaking_letter_notes": "string",
"instruction_sent_date": "string",
"instruction_sent_notes": "string",
"buyer_signed_date": "string",
"buyer_signed_notes": "string",
"seller_signed_date": "string",
"seller_signed_notes": "string",
"deposit_received_date": "string",
"deposit_received_notes": "string",
"conditions_met_date": "string",
"conditions_met_notes": "string",
"final_date": "string",
"lodged_date": "string",
"lodged_notes": "string",
"closed_referral_fee": false,
"closed_referral_fee_date": "string",
"closed_referral_fee_notes": "string",
"closed_royalty_fee": false,
"closed_royalty_fee_date": "string",
"closed_royalty_fee_notes": "string",
"closed_invoices_sent": false,
"closed_invoices_sent_date": "string",
"closed_invoices_sent_notes": "string",
"closed_date": "string",
"cancelled_date": "string",
"registered_date": "string",
"registered_notes": "string",
"cancelled_reason": "string"
}
]
}

NameDescription

order_by

string

Which field to use when ordering the results.

offset

integer

Offset for Pagination

limit

integer

Page Size

Responses

200
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active