The REST and SOAP APIs require a client to have a certain permissions in order to be able to use specific functions.
These permissions are group grouped by extension packs which are listed below, along with their respective endpoints and methods.
Extensions | SOAP Methods | REST Endpoints |
---|
Basic | ClearCache DeleteNotification GetGeneralProperties GetGeneralProperty GetAreas GetNegotiator GetNegotiators GetNumGeneralProperties GetOffice GetOffices GetPropertyPDF GetPropertySubPlots GetSessionID GetVersion ImportApplicant MessageNegotiator MessageOffice PropertyEnquiry RecordPropertyUserInteraction SaveGeneralNotification GetPropertyThumbnail | GET /departments GET /version GET /negotiators/{ID} POST /negotiators/{ID}/message POST /offices/{ID}/message GET /offices/{ID}/negotiators GET /offices/{ID} GET /offices GET /postcodes/{Postcode}/offices GET /properties GET /properties/{ID}/thumbnail POST /applicant POST /properties/{ID}/enquiry POST /properties/{ID}/record/userInteraction
|
Auction | GetAuctions GetLots GetPropertyAuction | GET /auctions GET /auctions/{ID}/lots GET /properties/{ID}/auction |
Open House | GetOpenHouseDates GetOpenHouseProperties | GET /viewings/openhouse/properties GET /properties/{ID}/viewings/openhouse |
Vendor | AddOfferNote ApproveBrochure GetDevelopmentReport GetNotesOfInterest GetOffer GetOffers GetPropertyOffers GetVendor GetVendorAccessToken GetVendorDocument GetVendorDocuments GetVendorProperties GetVendorPropertyDocuments GetVendorSolicitor VendorLogin | GET /vendors/{ID}/properties GET /properties/{ID}/notesOfInterest GET /properties/{ID}/offers GET /offers/{ID} POST /offers/{ID}/note GET /properties/{ID}/vendor GET /vendors/{ID}/documents GET /vendor/documents/{ID} GET /vendor/properties/{ID}/documents GET /properties/{ID}/vendor/solicitor GET /developments/{ID}/report |
Marketing | GetAdvertisements GetMarketingStats GetPropertyUserInteractionData GetViewing GetViewings | GET /properties/{ID}/viewings GET /viewings/{ID} GET /properties/{ID}/marketing/stats GET /properties/{ID}/marketing/advertisements GET /properties/{ID}/interaction/user PATCH /properties/approveBrochure/{ID} |
Landlord | AddWorksOrderNote CompletePreTenancyCheck GetCurrentTenancy GetInspections GetLandlord GetLandlordDocument GetLandlordDocuments GetLandlordProperties GetLandlordPropertyDocuments GetLandlordPropertyTransactions GetLandlordTenancyDocuments GetPropertyLandlordID GetRentReviews GetTenancies GetWorksOrders LandlordLogin | GET /properties/{ID}/landlord GET /landlords/{ID}/properties GET /landlords/{ID}/documents GET /landlord/properties/{ID}/documents GET /landlord/tenancies/{ID}/documents GET /landlord/documents/{ID} GET /landlord/properties/{ID}/transactions GET /landlords/{ID}/transactions GET /properties/{ID}/tenancies GET /properties/{ID}/tenancy/current GET /properties/{ID}/inspections GET /properties/{ID}/rentReviews GET /landlords/{ID} POST /worksOrders/{ID}/note |
Applicant | AddContactNote AddContactSearch AddContactSearch CreateOffer GetApplicant GetApplicantOffers GetApplicantViewings GetApplicants GetBuyer GetBuyerSolicitor GetContact GetContacts GetErasedContacts GetMatchAreas GetMatchedProperties GetViewedProperties SaveViewingFeedback UpdateApplicantSearch UpdateContactDetails | GET /matchAreas GET /applicants/{ID} GET /applicants PUT /applicants/{ID} PATCH /applicants/{ID} GET /contacts/{ID} POST /contacts/{ID}/search PUT /contacts/{ID} PATCH /contacts/{ID} GET /contacts GET /erasedContacts GET /applicants/{ID}/offers GET /applicants/{ID}/properties/matched GET /applicants/{ID}/properties/viewed GET /applicants/{ID}/properties/saved POST /applicants/{ID}/properties/{PropertyID} DELETE /applicants/{ID}/properties/{PropertyID} GET /applicants/{ID}/viewings POST /viewings/{ID}/feedback GET /properties/{ID}/buyer GET /properties/{ID}/buyer/solicitor POST /offer POST /contacts/{ID}/note |
Tenancy | GetWorksOrder GetNewTenancies | GET /tenancies/{ID}/worksOrders POST /tenancies/{ID}/fault POST /worksOrders/{ID}/image GET /worksOrders/{ID} POST /tenancies/issues/fixflo GET /tenancies POST /tenancyChecks/{ID}/document PATCH /tenancies/completePreTenancyCheck/{ID} |
Appliance | | POST /appliances/{ID}/document |
Tenant | GetTenancy GetTenancyInspections GetTenancyRentReviews GetTenancyTenant GetTenancyWorksOrders GetTenant GetTenantDocument GetTenantDocuments GetTenantTenancies GetTenantTenancyDocuments GetTenantTenancyTransactions ImportFixfloIssues ReportFault TenantLogin | GET /tenants/{ID}/tenancies GET /tenancies/{ID}/tenant GET /tenants/{ID} GET /tenancies/{ID} GET /tenants/{ID}/documents GET /tenant/documents/{ID} GET /tenant/tenancies/{ID}/documents GET /tenant/tenancies/{ID}/transactions GET /tenancies/{ID}/rentReviews GET /tenancies/{ID}/inspections |
Mailing | AddContactCategory AddToMailingList DisableMatchEmails EnableMatchEmails GetCategories GetCategory GetMailingList GetMailingLists OptInToMarketing OptOutOfMarketing RemoveContactCategory RemoveFromMailingList Unsubscribe | GET /mailingLists GET /mailingLists/{ID} GET /categories GET /categories/{ID} POST /mailingLists/{ID}/contact DELETE /mailingLists/{ID}/contacts/{ContactID} POST /categories/{ID}/contact DELETE /categories/{ID}/contacts/{ContactID} POST /unsubscribe POST /contacts/{ID}/marketing DELETE /contacts/{ID}/marketing POST /applicants/{ID}/match DELETE /applicants/{ID}/match |
Event | GetEvents | GET /events |
Diary | CancelAppointment GetAppointments GetAppointmentsByType GetContactAppointments GetDiaryEntry GetNegotiatorAppointments GetNegotiatorAvailability GetValuationAppointments GetViewingAppointments RequestAppointment | GET /negotiators/{ID}/availability GET /negotiators/{ID}/appointments GET /appointments POST /appointment GET /valuationAppointments GET /viewingAppointments GET /availability DELETE /appointments/{ID} |
IDCheck | AddContactIDCheck GetContactIDCheck SetContactIDCheckDate SetContactIDCheckStatus | GET /contacts/{ID}/id/check POST /contacts/{ID}/id/check PATCH /contacts/{ID}/id/check/status/{Status} PATCH /contacts/{ID}/id/check/date/{Date} |
Property | | PATCH /properties/{ID} POST /properties/{ID}/buyer/solicitor/{SolicitorID} POST /properties/{ID}/vendor/solicitor/{SolicitorID} |
Referral | GetPropertyReferrals GetReferral UpdateReferral | GET /referrals/{ID} PATCH /referrals/{ID} GET /properties/{ID}/referrals |
Accounts | | GET /vat/rates POST /properties/{ID}/charge |
...