FileNotes

Retrieves file notes by criteria

Retrieves file notes matching the search criteria

get/file-notes/search

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/file-notes/search
  • Auth: appAuth (a scheme the document does not define)

Query parameters

contact-idstring

The unique identifier of the contact

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Returns the file notes associated with the specified contact

idinteger

The unique identifier of the file note

titlestring nullable

Title of the file note if available

notesstring nullable

The body/content of the file note

contactIdsinteger[] nullable

The unique identifiers of contacts associated to the file note

propertyIdinteger nullable

The unique identifier of the property if one is associated to the file note

createdDatestring date-time

Date/time when file note was created

updatedDatestring date-time nullable

Date/time when file note was modified

negotiatorIdinteger nullable

The unique identifier of the negotiator

fileNoteType'Unspecified' | 'PropertyAvailable1' | 'PropertyWithdrawn' | 'PropertyUnderOffer' | 'ContractsExchanged' | 'PropertySaleCompleted' | 'PropertySoldExternally' | 'PropertyArchived' | 'PropertyLet' | 'PropertyAvailableAgain' | 'PropertyUnarchived' | 'PropertySuspended' | 'PropertyInstructed' | 'PropertyImported' | 'LetAgreed' | 'ExternallyLet' | 'PropertyBranchTransfer' | 'TermsSigned' | 'DetailsToVendor' | 'DetailsApproved' | 'HIPOrder' | 'HIPReady' | 'LogEPCOrder' | 'LogEPCReady' | 'SalePriceChange' | 'MarketingStatus' | 'SentOutSub' | 'SentOutCO' | 'RentalPriceChange' | 'FileNote' | 'PhoneCall' | 'TextMessage' | 'EMail' | 'Letter' | 'Labels' | 'MSReferra' | 'LeadNote' | 'ConversionNote' | 'ViewingFollowUp' | 'OfferMade' | 'OfferRevised' | 'OfferWithdrawn' | 'OfferAccepted' | 'OfferRejected' | 'OfferMadeRental' | 'OfferRevisedRental' | 'SaleNegotiated' | 'SaleWithdrawalByVendor' | 'SaleWithdrawalByPurchaser' | 'SaleLostExternalSale' | 'FailedToComplete' | 'ContractRaceLost' | 'LettingsWithdrawalByLandlord' | 'LettingsWithdrawalByApplicant' | 'KeyHandOver' | 'InvoiceRaised' | 'DepositTaken' | 'DepositReturned' | 'KeysOut' | 'KeysIn' | 'AccountPayment' | 'BoardChange' | 'Advertisement' | 'MoneyLaunderingIDRequest' | 'MoneyLaunderingIDVerified' | 'GasSafetyCheckOK' | 'ElectricalCheckOK' | 'FireAndFurnishingsCheckOK' | 'NoticeServed' | 'RecurringDiaryEntry' | 'GeneralDiaryEntry' | 'MarketAppraisal' | 'Viewing' | 'Match' | 'Disbursement' | 'MarketAppraisalFellThrough' | 'VendorReport' | 'MarketingSent' | 'ChangeOfPropertyNegotiator' | 'ChangeOfContactNegotiator' | 'ContactArchived' | 'PersonRegistered' | 'TOBSent' | 'TOBReturned' | 'ExportToCFP' | 'PropertyUploaded' | 'MarketingPrinted' | 'MarketingProduced' | 'MarketingViewed' | 'OtherMarketing' | 'MarketingFollowUp' | 'ReinstatePerson' | 'AllocateLogin' | 'PropertyOwnershipChanged' | 'TodoFollowUpNoteChanged' | 'DocumentSharedWithTenant' | 'DocumentUnsharedWithTenant' | 'DocumentSharedWithLandlord' | 'DocumentUnsharedWithLandlord' | 'FSReferral' | 'SolicitorReferral' | 'ConveyancerReferral' | 'ConveyancerQuote' | 'ConveyancerCaseOpened' | 'KeySetLost' | 'KeySetAdded' | 'KeySetRemoved' | 'KeySetAmended' | 'GeneralDiaryEntryCancelled' | 'AppraisalCancelled' | 'ViewingCancelled' | 'ExternalSaleAdded' | 'PropertySaleOtherStatusChange' | 'PropertyRentalOtherStatusChange' | 'ContractsExchangedReversed' | 'PropertySaleCompletedReversed' | 'SMSInvalidNumber' | 'PropertyBrochureSentViaEmail' | 'PropertyDetailsSentInEmail' | 'PropertyDetailsSentInSMS' | 'PropertyBrochurePrinted' | 'AdvertRunSentViaEmail' | 'PropertyUploadedFirstTime' | 'PropertyUploadedAsDeletion' | 'PropertyBrochureSentWithLetter' | 'PropertyBrowseSheetSentWithLetter' | 'ContactUnarchived' | 'GeneralDiaryEntryReinstated' | 'ViewingReinstated' | 'AppraisalReinstated' | 'ContactBranchTransfer' | 'CreditNoteIssued' | 'PropertyLetReversed' | 'ViewingReminder' | 'AppraisalReminder' | 'ClientDataChangeNote' | 'SigningRequestCopyEmail' | 'SigningRequest' | 'ViewingFeedbackReceived' | 'ViewingFeedbackRequested' | 'AmlCheckRequest' | 'SalesCommissionDue' | 'LettingsFeeDue' | 'DepositDue' | 'DisbursementRechargeDue' | 'RentDue' | 'ContractorExpenseDue' | 'SalesCommissionDueReversal' | 'LettingsFeeDueReversal' | 'DepositDueReversal' | 'DisbursementRechargeDueReversal' | 'RentDueReversal' | 'ContractorExpenseDueReversal' | 'TaskExpired' | 'SubjectAccessRequest' | 'DataPortabilityRequest' | 'SubjectAccessRequestPerson2' | 'DataPortabilityRequestPerson2' | 'PropertyAdded' | 'VacateTenancy' | 'RenewTenancy' | 'VacatedTenancy' | 'RenewedTenancy' | 'PeriodicTenancy' | 'RenewalCancelled' | 'VacateCancelled' | 'TenantAdded' | 'TenantRemoved' | 'TenancyStarted' | 'TenantLeft' | 'FailedToLet' | 'TenancyAdded' | 'VacateTenancyReverted' | 'RenewedTenancyReverted' | 'ReferencingCheckRequested' | 'ReferencingTenantStatusUpdated' | 'TenancyDepositSchemeUpdated' | 'WorkOrderCreated' | 'WorkOrderStatusChanged' | 'WorkOrderQuoteRequest' | 'WorkOrderInstructSupplier' | 'ManagementDateProgressChanged' | 'PropertyFileMaintenanceRequestReceived' | 'ForcedPasswordReset' | 'ForgottenPassword' | 'TwoStepSecurityCode' | 'ExportTenancy' | 'ContactCreatedFromLead' | 'TermsSent' | 'UpdateSalesFees' | 'PropertyCloned' | 'ContactCreatedFromBookingRequest' | 'PmInvoice' | 'PmReceipt' | 'PmRefund' | 'PmLandlordPayment' | 'PmSupplierPayment' | 'PmAgencyPayment' | 'PmBankReconciliation' | 'PmBacsPayment' | 'PmBankTransfer' | 'PmOverseasPayment' | 'pmBacsDownloadRequest' | 'PmPeriodStatement' | 'PmReceiptImportFile' | 'PmReceiptImportUpdate' | 'PmReceiptImportFileDownload' | 'TdsCertificateReceived' | 'TdsUploadBlocked' | 'SelfBillingInvoiceEmailed' | 'ConveyancerReferralFinanceReportEmailed' nullable

Changes

No recorded changes to this operation across all 1 revision of this API.