Contacts
Search All Contacts
Search for all matching contacts and return a paginated list of results.
get/contacts/search
Request
- Base URL: https://api.alto.zoopladev.co.uk
- URL: https://api.alto.zoopladev.co.uk/contacts/search
- Auth: appAuth (a scheme the document does not define)
Query parameters
querystring required
Example:07700 900000
The query term to search for contacts. This can match on names, addresses, email addresses, phone numbers, unique identifiers, reference codes, and company names where applicable.
archivedboolean
Optional filter to only show or exclude archived contacts.
contact-type'Unknown' | 'Client' | 'Solicitor' | 'BuildingSociety' | 'Bank' | 'Publication' | 'EstateAgent' | 'ManagingAgent' | 'Developer' | 'Builder' | 'Utility' | 'Service' | 'PreviousClient' | 'Miscellaneous' | 'FinancialAdvisor' | 'Maintenance' | 'OnSiteSales' | 'ExternalPrinter' | 'OtherCategory1' | 'EstateAgentLocal' | 'Surveyor' | 'Supplier' | 'Accountant'
Example:Client
Optional filter to only search a single contact type.
next-tokenstring
The token for the next page of results.
max-resultsinteger
The maximum number of results to return. The default value is 50, and the maximum value is 250
created-fromstring date-time
The start date for by created date.
created-tostring date-time
The end date for by created date.
modified-fromstring date-time
The start date for by modified date.
modified-tostring date-time
The end date for by modified date.
Headers
AgencyRefstring required
Response
OK
Example response
{
"items": [
{
"people": [
{
"personId": "1",
"title": "Mr",
"forename": "John",
"surname": "Doe",
"emails": [
{
"emailAddress": "john.doe@business.com"
}
],
"phoneNumbers": [
{
"phoneNumber": "01234567891"
}
]
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.