Get a Saved Location

Get an existing Saved Location.

Get a Saved Location

get

Authorizations

BearerAuth

Path parameters

location_idstringRequired

An existing Saved Location ID.

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/saved-locations/{location_id}

HTTPcURLJavaScriptPython

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

{
  "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-21T09:13:31.781Z",
  "update_dt": "2025-10-21T09:13:31.781Z",
  "enrich_dt": "2025-10-21T09:13:31.781Z",
  "insights_dt": "2025-10-21T09:13:31.781Z",
  "user_id": "text",
  "subscription_valid_types": [
    "broadcasts"
  ],
  "status": "active",
  "summary_insights": [
    {
      "date_range": {
        "type": "text",
        "start_dt": "2025-10-21T09:13:31.781Z",
        "end_dt": "2025-10-21T09:13:31.781Z"
      },
      "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/_4Dl3p4Q2zl4ifMjG4Z3ew' \
--header 'Authorization: Bearer TOKEN'

python

import requests

url = "https://api.predicthq.com/v1/saved-locations/_4Dl3p4Q2zl4ifMjG4Z3ew"
headers = {
  'Authorization': 'Bearer TOKEN'
}

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

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