Jump to Content

Guides API Reference Changelog

v1.0

API Reference

prodGuides API Reference Changelog

Leads API

REST Endpoints
- /appraisal-leadsget
- /applicant-leadsget

Premium Listing activations

/products/premium-listings/{uuid}
- Returns listing for specific uuidget
- Updates highlights for a specific uuidpatch
/products/premium-listings
- Returns all requested upgrades to premium listings that the caller has access toget
- Create the new upgrade to premium listingpost

Weekly Featured Property (WFP) Activations

/products/weekly-featured-properties/{uuid}
- Returns a WFP activated listing for a specific uuidget
/products/weekly-featured-properties
- Returns all requested upgrades to WFPs that the caller has access toget
- Activate a listing as a WFPpost

Zoopla Performance Reporting

enhanced
- Request an enhanced report (Coming soon)post
- Retrieve an enhanced report (Coming soon)get

Alto.Clients.Api

Clients
- This endpoint is now obsolete. Use /contacts endpoint instead.get

Alto.Contacts.Api

Contacts
Owners
- Get Ownersget
Parameters

Alto.PropertyManagement.Api

Landlords
- /inventory/{inventoryId}/landlordsget
- List Landlordsget
ManagementEvents
Suppliers
Tenancies
Charges
- /inventory/{propertyId}/chargespost
- /tenancies/{tenancyId}/chargespost
WorkOrders

Alto.Documents.Api

Documents

Alto.SalesProgression.Api

SalesProgression
- /sales-progressionsget
- /sales-progressions/{offerId}get

Alto.LettingsProgression.Api

LettingsProgression
- /guarantorIdsget
ReferenceChecks
- /ReferenceChecksget
- /ReferenceChecks/{referenceCheckId}patch

Alto.Listing.Api

Listing

Alto.CLM.Api

Branches
- Get Branchesget
- Get Branch By Idget
Negotiators
- Get Negotiatorsget
- Get Negotiator By Idget

Alto.Inventory.Api

Inventory

Alto.PartnerReferrals.Api

Referrals
- /referrals/{referralId}get
- Updates a referral using JSON Patchpatch

Alto.Appointments.Api

Appointments
Parameters
- Get general appointment sub-types.get

Alto.Leads.Api

Leads

Alto.Appraisal.Api

Appraisals
- Create an appraisalpost

Alto.FileNotes.Api

FileNotes

Alto.VoidSwitching.Api

Referral
- /voidswitching/referrals/{referralId}patch

Alto.Offers.Api

Getting Started With Your API

Alto.Offers.Api

Offers
- Gets a sales offer by offerIdget

Alto.Media.Api

Media
- Create new media itempost

Get Person by Contact Id

get

https://example.com/contacts/{contactId}/persons/{personId}

See glossary for definition of Person.

Language

Click Try It! to start a request and see the response here!