Skip to content
Sesharo Docs

Search Places Endpoint

GET
/users/{user_id}/places/search
curl --request GET \
  --url 'https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/places/search?q=example&limit=8'

Forward search (name/address → coordinates) via Photon, biased to (lat, lng) when supplied — powers the manual add-place search box (“chick fil a”). Queries under 3 chars short-circuit so a half-typed term doesn’t hit the provider. Network-failure-tolerant (empty list, never a 5xx).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
q
required
Q
string
<= 200 characters
lat
Any of:
number
>= -90 <= 90
lng
Any of:
number
>= -180 <= 180
limit
Limit
integer
default: 8 >= 1 <= 15

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Search Places Endpoint Users User Id Places Search Get
Array<object>
PlaceSearchResult

A forward-search match (name/address → coordinates) from Photon, for the add-place box.

object
address
Any of:
string
distance_m
Any of:
number
lat
required
Lat
number
lng
required
Lng
number
name
required
Name
string
Examplegenerated
[
  {
    "address": "example",
    "distance_m": 1,
    "lat": 1,
    "lng": 1,
    "name": "example"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}