HomeGuidesAPI ReferenceSupport
API Reference
Contact

Get Address Clusters

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

Get the Address clusters filtered by the corresponding query text, and with the option to filter the result by the 'routed' and 'unrouted' state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to all

Specify which Addresses to show in the corresponding query results.

Allowed:
display_list
array of strings

Specify which Addresses to show in the corresponding query results.

string

Search in the Addresses by the corresponding query phrase.

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