---
title: "Get suggestions for a place"
method: GET
path: "/places/v1/{place_handle}/suggestions/"
tags: ["Places"]
---

# Get suggestions for a place

`GET /places/v1/{place_handle}/suggestions/`

## Request

- Base URL: `https://v3.api.hypertrack.com`
- URL: `https://v3.api.hypertrack.com/places/v1/{place_handle}/suggestions/`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/places/v1/:place_handle/suggestions/get.ts> (a function with typed inputs; its response is checked against the schema)

Get suggestions for a place

## Path parameters

- `place_handle` string, required

## Query parameters

- `suggested_on_from` string, nullable
- `suggested_on_to` string, nullable
- `pagination_token` string, nullable
- `limit` integer, nullable

## Response `200`

Successful response

- SuggestionListResponse
  - `suggestions` SuggestionResponse[], required: List of suggestions
    - `suggestion_id` string, required: Unique identifier for the suggestion
    - `geometry` union, required: Suggested location or geofence for this place
      - PointGeometry
        - `coordinates` number[], required: Location coordinates represented as [longitude, latitude]
        - `type` 'Point': Geometry type
      - PolygonGeometry
        - `type` 'Polygon', required: Geometry type
        - `coordinates` array[], required: Location coordinates represented as [[[longitude, latitude], [lon, lat]...]]
          - array[]
            - number[]
    - `radius` integer, nullable: Radius in meters for point geometry suggestions
    - `hex_id` string, required: Hex ID associated with this suggestion
    - `applied_by` string, nullable: User who applied this suggestion
    - `applied_on` string, nullable: Time when this suggestion was applied
    - `suggested_by` string, nullable: User who suggested this geofence
    - `suggested_on` string, required: Time when this suggestion was made
    - `order_handle` string, nullable: Order handle associated with this suggestion
    - `source` 'ht_generated' | 'customer_provided': Source which created this suggestion
    - `type` string: Type of suggestion (manual, inferred, bounding_box)
    - `skew` number, nullable: Skew between current geofence and suggestion, values can be between 0 and 1. 0 means no skew (perfect overlap) and 1 means no overlap
    - `area_ratio` number, nullable: Ratio of suggested geometry area to current geofence area (suggested/current)
    - `centroid_shift` number, nullable: Distance in meters between the centroid of current geofence and suggestion
    - `inclusivity` string, nullable: More inclusivity means more loosely defined service area
  - `pagination_token` string, nullable: Token to fetch the next page of suggestions

## Other responses

- `400`: Validation error
- `401`: Authentication error
- `404`: Not found

---

[API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)
