Jump to Content
Guides
API Reference
Changelog
v1.0
API Reference
prod
Guides
API Reference
Changelog
/management-events/{eventId}
Search
JUMP TO
Leads API
REST Endpoints
/appraisal-leads
get
/applicant-leads
get
Premium Listing activations
/products/premium-listings/{uuid}
Returns listing for specific uuid
get
Updates highlights for a specific uuid
patch
/products/premium-listings
Returns all requested upgrades to premium listings that the caller has access to
get
Create the new upgrade to premium listing
post
Weekly Featured Property (WFP) Activations
/products/weekly-featured-properties/{uuid}
Returns a WFP activated listing for a specific uuid
get
/products/weekly-featured-properties
Returns all requested upgrades to WFPs that the caller has access to
get
Activate a listing as a WFP
post
Zoopla Performance Reporting
standard
Retrieve a standard report
post
enhanced
Request an enhanced report (Coming soon)
post
Retrieve an enhanced report (Coming soon)
get
Alto.Clients.Api
Clients
/clients
get
Alto.Contacts.Api
Contacts
Get Contact(s) by Id(s)
get
Create Contact
post
Get Person(s) by Contact Id
get
Update Contact by Id
patch
Update Applicant Requirement by Id
patch
Get Bank Accounts by Contact Id
get
Create Contact Forwarding Address
post
Get Person(s) by Contact Id
get
Update Person by Contact Id
patch
Get Person by Contact Id
get
Gets all contact relationships for a client contact. This can be used for example to get all relationships for a client contact such as guarantors and forwarding addresses.
get
Create a relationship between a client contact and a non-marketable relationship contact. This can be used for example to create a relationship between a client contact and its guarantor.
post
Deletes a relationship between a client contact and a non-marketable relationship contact. This can be used for example to delete a relationship between a client contact and its guarantor that was created using the POST endpoint.
delete
Get All Contacts
get
Owners
Get Owners
get
Parameters
Get Client Disposal Statuses
get
Get Client Intentions
get
Get Client Positions
get
Get Lead Sources
get
Alto.PropertyManagement.Api
Landlords
/inventory/{inventoryId}/landlords
get
ManagementEvents
Gets management events for a specific inventory item
get
Gets a list of management events
get
Gets a single management event by ID
get
/management-events/{eventId}
patch
Tenancies
/inventory/{inventoryId}/tenancies
get
/tenancies/{tenancyId}
get
Updates a tenancy using JSON Patch
patch
Get Meter Readings by Tenancy Id
get
Post tenancy meter reading
post
Patch tenancy meter reading by type of utility.
patch
/tenancies/{tenancyId}/tenantIds
get
Charges
/inventory/{propertyId}/charges
post
/tenancies/{tenancyId}/charges
post
Suppliers
/suppliers
get
/suppliers/{supplierId}
get
WorkOrders
Post Work Order
post
Gets Work Order by Id
get
Patch Work Order by Id
patch
Alto.Documents.Api
Documents
Get documents by document type.
get
Get document content by DocumentId.
get
Upload a new document
post
Get documents by PropertyId.
get
Get documents by WorkOrderId.
get
Alto.SalesProgression.Api
SalesProgression
/sales-progressions
get
/sales-progressions/{offerId}
get
Alto.LettingsProgression.Api
LettingsProgression
/guarantorIds
get
ReferenceChecks
/ReferenceChecks
get
/ReferenceChecks/{referenceCheckId}
patch
Alto.Listing.Api
Listing
Filter property listings
get
Get a property listing
get
Get property images metadata
get
Get a property listing image
get
Get multiple property listings
get
Alto.CLM.Api
Branches
Gets a paginated list of branches.
get
Gets a branch by id.
get
Negotiators
Gets a paginated list of negotiators
get
Alto.Inventory.Api
Inventory
/inventory
get
Get an inventory item
get
/inventory/{inventoryId}
patch
Associates a Contact with an Inventory item as its Owner
post
Filter inventory items
get
Get multiple inventory items
get
Creates an inventory item
post
Search inventory items
get
Alto.PartnerReferrals.Api
Referrals
/referrals/{referralId}
get
Updates a referral using JSON Patch
patch
Alto.Appointments.Api
Appointments
Retrieves an appointment by their unique identifier and numeric instance
get
Create a general appointment.
post
Updates an existing general appointment
patch
Get negotiator's appointments within a selected time range.
get
Create a viewing appointment.
post
Parameters
Get general appointment sub-types.
get
Alto.Leads.Api
Leads
Gets a paginated list of Leads
get
Update Lead by Id
patch
Alto.Appraisal.Api
Appraisals
Create an appraisal
post
Alto.FileNotes.Api
FileNotes
Create a file note
post
Get a file note
get
Retrieves file notes by criteria
get
Alto.Internal.Contacts.Api
ContactsSearch
Gets a paginated list of contact search results.
get
Alto.VoidSwitching.Api
Referral
/voidswitching/referrals/{referralId}
patch
/management-events/{eventId}
patch
https://example.com/management-events/
{eventId}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
