HomeGuidesAPI ReferenceSupport
API Reference
Contact

Filter by Address Book Group ID 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 sending the corresponding body payload and by specifying the 'display' and 'group_id' query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Group Id

Query Params
string
enum
Defaults to all

Specify which Addresses to show in the corresponding query results.

Allowed:
Body Params
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