street_list_properties
List properties
List properties (sales and lettings listings, with address, status, price, bedrooms and the owner link). Newest first as Street orders them; page with page and page_size. GET /properties.
Parameterspagetagsbranchstatusaddressincludetrashedbedroomscategorypostcodepage_sizecreated_to+9 more
street_get_property
Get property
One property by UUID, with the related records you ask for in include. GET /properties/{id}.
Parametersincludeproperty_idrequired
street_list_people
List people
List people (contacts: name, emails, phones, addresses, contact preferences). Newest first as Street orders them; page with page and page_size. GET /people.
Parameterspageaddressincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_fromemail_addresstelephone_number
street_get_person
Get person
One person by UUID, with the related records you ask for in include. GET /people/{id}.
Parametersincludeperson_idrequired
street_list_vendors
List vendors
List vendors (people selling a property). Newest first as Street orders them; page with page and page_size. GET /vendors.
Parameterspageaddressincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_fromemail_addressperson_statusproperty_status+1 more
street_get_vendor
Get vendor
One vendor by UUID, with the related records you ask for in include. GET /vendors/{id}.
Parametersincludevendor_idrequired
street_list_landlords
List landlords
List landlords (people letting a property). Newest first as Street orders them; page with page and page_size. GET /landlords. The public Street Open API does not expose bank-detail presence or masked account digits. Bank details are unknown through this API; do not treat an absent field as missing bank details.
Parameterspageaddressincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_fromemail_addressperson_statusproperty_status+1 more
street_get_landlord
Get landlord
One landlord by UUID, with the related records you ask for in include. GET /landlords/{id}. The public Street Open API does not expose bank-detail presence or masked account digits. Bank details are unknown through this API; do not treat an absent field as missing bank details.
Parametersincludelandlord_idrequired
street_list_tenants
List tenants
List tenants. Newest first as Street orders them; page with page and page_size. GET /tenants.
Parameterspageaddressincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_fromemail_addressperson_statustelephone_number
street_get_tenant
Get tenant
One tenant by UUID, with the related records you ask for in include. GET /tenants/{id}.
Parametersincludetenant_idrequired
street_list_sales_applicants
List sales applicants
List sales applicants (buyers: budget, bedrooms, areas, buying and financial position, lead rating). Newest first as Street orders them; page with page and page_size. GET /sales-applicants.
Parameterspageareasbranchincludetrashedprice_topage_sizecreated_toprice_fromupdated_tolead_ratingcreated_from+6 more
street_get_sales_applicant
Get sales applicant
One sales applicant by UUID, with the related records you ask for in include. GET /sales-applicants/{id}.
Parametersincludesales_applicant_idrequired
street_list_lettings_applicants
List lettings applicants
List lettings applicants (prospective tenants: budget, bedrooms, areas, furnished, lead rating). Newest first as Street orders them; page with page and page_size. GET /lettings-applicants.
Parameterspageareasbranchincludetrashedprice_tofurnishedpage_sizecreated_toprice_fromupdated_tolead_rating+5 more
street_get_lettings_applicant
Get lettings applicant
One lettings applicant by UUID, with the related records you ask for in include. GET /lettings-applicants/{id}.
Parametersincludelettings_applicant_idrequired
street_list_enquiries
List enquiries
List enquiries (inbound leads: who, which property, message, source). Newest first as Street orders them; page with page and page_size. GET /enquiries.
Parameterspagebranchtrashedpage_sizecreated_toupdated_tocreated_fromupdated_fromemail_addresstelephone_number
street_get_enquiry
Get enquiry
One enquiry by UUID, with the related records you ask for in include. GET /enquiries/{id}.
Parametersincludeenquiry_idrequired
street_list_viewings
List viewings
List viewings (property, applicant, time, status, feedback). Newest first as Street orders them; page with page and page_size. GET /viewings.
Parameterspagetypebranchstatusincludetrashedbooked_tocancelledpage_sizecreated_toupdated_tobooked_from+2 more
street_get_viewing
Get viewing
One viewing by UUID, with the related records you ask for in include. GET /viewings/{id}.
Parametersincludecancelledviewing_idrequired
street_list_valuations
List valuations
List valuations (market appraisals: property, valuer, time, status, outcome). Newest first as Street orders them; page with page and page_size. GET /valuations.
Parameterspagetypebranchstatusincludetrashedbooked_tocancelledpage_sizecreated_toupdated_tobooked_from+2 more
street_get_valuation
Get valuation
One valuation by UUID, with the related records you ask for in include. GET /valuations/{id}.
Parametersincludecancelledvaluation_idrequired
street_list_sales
List sales
List sales (the sales progression records: agreed price, buyer, vendor, solicitors, status). Newest first as Street orders them; page with page and page_size. GET /sales.
Parameterspagebranchstatusincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
One sale by UUID, with the related records you ask for in include. GET /sales/{id}.
Parametersincludesale_idrequired
street_list_sales_offers
List sales offers
List sales offers (amount, applicant, property, status). Newest first as Street orders them; page with page and page_size. GET /sales-offers.
Parameterspagebranchstatusincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
street_get_sales_offer
Get sales offer
One sales offer by UUID, with the related records you ask for in include. GET /sales-offers/{id}.
Parametersincludesales_offer_idrequired
street_list_lettings_offers
List lettings offers
List lettings offers (rent, applicant, property, status). Newest first as Street orders them; page with page and page_size. GET /lettings-offers.
Parameterspagebranchstatusincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
street_get_lettings_offer
Get lettings offer
One lettings offer by UUID, with the related records you ask for in include. GET /lettings-offers/{id}.
Parametersincludelettings_offer_idrequired
street_list_tenancies
List tenancies
List tenancies (property, tenants, owner, rent, dates). Newest first as Street orders them; page with page and page_size. GET /tenancies.
Parameterspageincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
street_get_tenancy
Get tenancy
One tenancy by UUID, with the related records you ask for in include. GET /tenancies/{id}.
Parametersincludetenancy_idrequired
street_list_maintenance_jobs
List maintenance jobs
List maintenance jobs (read-only: property, status, assignee, dates). Newest first as Street orders them; page with page and page_size. GET /maintenance-jobs.
Parameterspagestatusincludetrashedpage_sizecreated_toupdated_toreported_tocompleted_tocreated_fromupdated_fromreported_from+1 more
street_get_maintenance_job
Get maintenance job
One maintenance job by UUID, with the related records you ask for in include. GET /maintenance-jobs/{id}.
Parametersmaintenance_job_idrequired
street_list_tasks
List tasks
List tasks (to-dos with title, due date, assignee and the record they relate to). Newest first as Street orders them; page with page and page_size. GET /todos.
Parameterspagebranchincludesubjecttrashedpropertypage_sizecreated_toupdated_tocreated_fromupdated_from
street_list_follow_ups
List follow ups
List follow-ups (due date, note, and the property, applicant, sale or valuation they belong to). Newest first as Street orders them; page with page and page_size. GET /follow-ups.
Parameterspagebranchincludesubjecttrashedpropertypage_sizecreated_toupdated_tocreated_fromupdated_from
street_list_branches
List branches
List branches (name, address, contact details). Newest first as Street orders them; page with page and page_size. GET /branches.
Parameterspageincludetrashedpage_size
street_get_branch
Get branch
One branch by UUID, with the related records you ask for in include. GET /branches/{id}.
Parametersincludebranch_idrequired
street_list_users
List users
List users (the agency's staff: name, job title, contact details, deactivated state). Newest first as Street orders them; page with page and page_size. GET /users.
Parameterspageincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
One user by UUID, with the related records you ask for in include. GET /users/{id}.
Parametersincludeuser_idrequired
street_list_invoices
List invoices
List invoices (client accounting: property, owner, line items, paid and voided state). Newest first as Street orders them; page with page and page_size. GET /invoices.
Parameterspagepaidvoidedincludepage_sizeinvoice_type
street_get_invoice
Get invoice
One invoice by UUID, with the related records you ask for in include. GET /invoices/{id}.
Parametersincludeinvoice_idrequired
street_list_sales_instructions
List sales instructions
List sales instructions (an agreement to sell: property, owner, fees). Newest first as Street orders them; page with page and page_size. GET /sales-instructions.
Parameterspageincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
street_get_sales_instruction
Get sales instruction
One sales instruction by UUID, with the related records you ask for in include. GET /sales-instructions/{id}.
Parametersincludecancelledsales_instruction_idrequired
street_list_lettings_instructions
List lettings instructions
List lettings instructions (an agreement to let: property, owner). Newest first as Street orders them; page with page and page_size. GET /lettings-instructions.
Parameterspageincludetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
street_get_lettings_instruction
Get lettings instruction
One lettings instruction by UUID, with the related records you ask for in include. GET /lettings-instructions/{id}.
Parametersincludecancelledlettings_instruction_idrequired
street_list_inspections
List inspections
List property inspections (due date, booked date, inspector, status). Newest first as Street orders them; page with page and page_size. GET /inspections.
Parameterspagesortstatusincludebooked_topage_sizebooked_fromdue_date_todue_date_from
street_get_inspection
Get inspection
One inspection by UUID, with the related records you ask for in include. GET /inspections/{id}.
Parametersincludeinspection_idrequired
street_list_interested_applicants
List interested applicants
List interested applicants (applicants who showed interest in a property). Newest first as Street orders them; page with page and page_size. GET /interested-applicants.
Parameterspageincludepropertypage_size
street_get_interested_applicant
Get interested applicant
One interested applicant by UUID, with the related records you ask for in include. GET /interested-applicants/{id}.
Parametersincludeinterested_applicant_idrequired
street_list_task_types
List task types
List task types (the categories a task can have; use an id as task_type_id when creating a task). Newest first as Street orders them; page with page and page_size. GET /todo-types.
Parameterspagetrashedpage_sizecreated_toupdated_tocreated_fromupdated_from
street_list_areas
List areas
List areas (the area names used to match applicants and properties). Newest first as Street orders them; page with page and page_size. GET /areas.
Parameterspagetrashedpage_size
street_create_enquiry
Create enquiry
WRITE: record a new inbound enquiry (a lead) in Street. Street matches the email address to an existing person or creates one, and the agency's own automations may then email or assign the lead. Street requires the enquiry to be tied to exactly one record: pass property_id, or sales_applicant_id, or lettings_applicant_id. Pass the same enquiry_identifier on a retry: Street then returns the existing enquiry instead of creating a duplicate. POST /enquiries.
Parametersmessagerequiredpostcodebranch_idlast_namefirst_nameproperty_idcustom_sourceemail_addressrequiredproperty_to_letrequest_viewingproperty_to_selltelephone_number+4 more
street_create_note
Create note
WRITE: add a note to one Street record (a person, property, applicant, sale, viewing, tenancy and so on). The note is visible to the agency's staff. Not idempotent: calling it twice adds two notes. POST /notes.
Parametersbodyrequiredpinnedauthor_idtarget_idrequiredtarget_typerequired
street_create_task
Create task
WRITE: create a task (to-do) in Street, optionally assigned to a user and given a task type. Not idempotent: calling it twice creates two tasks. POST /todos.
Parametersbodynotetitlerequireduser_iddue_datetask_type_id
street_create_follow_up
Create follow-up
WRITE: schedule a follow-up on a property, sales or lettings applicant, sale or valuation. Not idempotent: calling it twice creates two follow-ups. POST /follow-ups.
Parametersnotedue_daterequiredtarget_idrequiredtarget_typerequired
street_create_maintenance_request
Create maintenance request
WRITE: log a maintenance request against a property (a request, not a job: Street staff turn it into a job). Not idempotent: calling it twice logs two requests. POST /maintenance-requests.
Parameterssummaryrequiredprioritydescriptionproperty_idrequiredreported_atreported_by
street_update_person
Update person
WRITE: change a person's title, name, marketing consent or contact preferences in Street. Street requires both names on every update, so the current record is read first and anything you leave out is sent back unchanged. Contact details (email, phone, address) cannot be changed through the API. PATCH /people/{id}.
Parameterstitlelast_nameperson_idrequiredfirst_namecontact_postcontact_textcontact_emailcontact_phonemarketing_consent