bad0d2db9b7a
Stream all sales & listings
Validation & Requirements
Required Parameters
- None
Required JSON Body Fields
- None
Validations
- Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
- Invalid date values in *date* fields return 422 Unprocessable Entity.
- Missing required request body returns 422 Unprocessable Entity with Missing request body..
- Additional business-rule validation may return 422 with details in the errors array.
Query parameters
Return only files created after this UTC datetime.
Return only files created before this UTC datetime.
Return only files modified after this UTC datetime.
Return only files modified before this UTC datetime.
Return only files whose checklist was last modified before this UTC datetime.
Return only files whose checklist was last modified after this UTC datetime.
Return only files closed after this UTC datetime. Setting this filter excludes listings, since closing dates do not apply to them.
Return only files closed before this UTC datetime. Setting this filter excludes listings, since closing dates do not apply to them.
The email of the listing or sale.
A search parameter that is a substring of the property address of the listing or sale. For example, propertyAddress=sacra will find files in the city Sacramento or on Sacramento St.
A search parameter that matches on property state abbreviation.
A search parameter that matches on property zip.
A comma separated list whose items can be all, sale, listing, or summary, and defaults to all.
A comma separated list whose items can be all, active, pending, closed, incomplete, expired, canceledPending, canceledApproved, and archived and defaults to all.
A comma separated list of stage names to include (case-insensitive). Only files whose stage matches one of these names are returned. Applies to both sales and listings. Mutually exclusive with excludeStage.
A comma separated list of stage names to exclude (case-insensitive). Files in these stages are omitted; files with no stage assigned are included. Applies to both sales and listings. Mutually exclusive with stage.
Response
Returns a JSON object with a 'value' array containing summary, listing, and sale objects. Items are streamed as they are retrieved — consumers can process each item as it arrives.