Search Saved Locations
Search for an existing Saved Location.
Request
HTTP Request
Query Parameters
location_id
string
A comma-separated string consisting of a list of 1 or more location_id's.
E.g. ?location_id=6TxvEapQeDzq9y_UKVRQCQ
q
string
A full-text search query that searches across the following fields:
name
description
location_code
formatted_address
labels
E.g. q=alabama
sort
string
A comma-separated list of fields to sort results by. Use the -
prefix to sort descending.
Possible values:
name
- Sort by name A-Z-name
- Sort by name Z-Acreated
- Sort by created date oldest to newest-created
- Sort by created date newest to oldestupdated
- Sort by updated date earliest to latest-updated
- Sort by updated date latest to earliestaddress
- Sort by address A-Z-address
- Sort by address Z-A
You can also sort by the summary insight values. Summary insights are calculated for different date ranges (currently only the next 90 days have been implemented) and you need to choose which date range to sort by.
Use the format below to sort by summary insights:
For example, below are the sort options for the summary insights calculated for the next 90d:
next_90d.phq_attendance_sum
next_90d.attended_event_count
next_90d.non_attended_event_count
next_90d.unscheduled_event_count
next_90d.pes_accommodation_sum
next_90d.pes_hospitality_sum
next_90d.pes_total_sum
next_90d.pes_transportation_sum
You can prefix these with a minus sign -
to reverse the order.
E.g.: ?sort=-created
limit
string
The maximum number of results to return. The default limit is 10.
E.g. ?limit=50
offset
string
Used for paging. The number of results to skip. The default is 0.
E.g. ?offset=20
Response
Response Fields
count
number
Total number of results found.
locations
array
List of results where each item is a Saved Location.
Please refer to the response fields section in Get a Saved Location for the structure of each record.
Examples
Guides
Below are some guides relevant to this API:
Last updated