HomeGuidesAPI ReferenceSupport
API Reference
Contact

Search Addresses

post
https://wh.route4me.com/modules/api/v5.0/address-book/addresses/index/all

Get all Addresses filtered and sorted by sending the corresponding body payload, with the option to search by the specified areas.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
fields
array of strings
Defaults to []
fields
filter
object
order_by
array of arrays of strings

You can sort the results using the specified fields: * address_1 * address_alias * first_name * last_name * address_phone_number * address_email * address_group * in_route_count * visited_count * last_visited_timestamp * last_routed_timestamp

order_by
number
≤ 10000
Defaults to 10000

Limit of the queried records number (maximum limit is 10000).

number
Responses

Updated 5 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago