HomeGuidesAPI ReferenceSupport
API Reference
Contact

Filter by Address Book Group rules and output as a list of Addresses

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

Filter the Address Book Contacts by the Address Book Group rules by sending the corresponding body payload with the option to filter the Contacts by 'Routed' or 'Unrouted'.

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:
Body Params
rules
object
required
bounding_box
object
fields
array of strings

Filter the results by the corresponding fields.

fields
order_by
array

You can sort the results using the following 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

Maximum limit is 10000

number
Defaults to 0
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