Search Saved Locations

Search for existing Saved Locations.

Search Saved Locations

get

Authorizations

BearerAuth

Query parameters

qstringOptional

A full-text search query that searches across the following fields:

• name
• description
• location_code
• formatted_address
• labels

E.g. q=alabama

offsetintegerOptional

Offset the results.

Default: 0

limitintegerOptional

Limit the number of results.

Default: 10

location_idstring[]Optional

A comma-separated string consisting of a list of 1 or more location_id's.

E.g. ?location_id=6TxvEapQeDzq9y_UKVRQCQ

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/saved-locations HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "locations": [
    {
      "location_code": "text",
      "name": "text",
      "labels": [
        "text"
      ],
      "geojson": {
        "type": "text",
        "properties": {
          "radius": 1,
          "radius_unit": "m"
        },
        "geometry": {
          "type": "Point",
          "coordinates": []
        }
      },
      "place_ids": [
        1
      ],
      "formatted_address": "text",
      "create_dt": "2025-10-08T13:12:55.343Z",
      "update_dt": "2025-10-08T13:12:55.343Z",
      "enrich_dt": "2025-10-08T13:12:55.343Z",
      "insights_dt": "2025-10-08T13:12:55.343Z",
      "user_id": "text",
      "subscription_valid_types": [
        "broadcasts"
      ],
      "status": "active",
      "summary_insights": [
        {
          "date_range": {
            "type": "text",
            "start_dt": "2025-10-08T13:12:55.343Z",
            "end_dt": "2025-10-08T13:12:55.343Z"
          },
          "phq_attendance_sum": 1,
          "attended_event_count": 1,
          "non_attended_event_count": 1,
          "unscheduled_event_count": 1,
          "demand_surge_count": 1,
          "venue_count": 1,
          "pes_total_sum": 1,
          "pes_accommodation_sum": 1,
          "pes_hospitality_sum": 1,
          "pes_transportation_sum": 1
        }
      ],
      "places": [
        {
          "place_id": 1,
          "type": "text",
          "name": "text",
          "county": "text",
          "region": "text",
          "country": "text",
          "geojson": {
            "type": "Feature",
            "geometry": {
              "type": "Point",
              "coordinates": []
            }
          }
        }
      ],
      "location_id": "text"
    }
  ]
}

Examples

curl

curl --location 'https://api.predicthq.com/v1/saved-locations?q=alabama&limit=50' \
--header 'Authorization: Bearer TOKEN'

python

import requests

url = "https://api.predicthq.com/v1/saved-locations?q=alabama&limit=50"

payload={}
headers = {
  'Authorization': TOKEN
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

OpenAPI Spec

The OpenAPI spec for Saved Locations API can be found here.

Guides

Below are some guides relevant to this API:

• Working with Location-Based Subscriptions