Skip to main content
GET
/
locations
/
api
/
v1
/
public
/
locations
Find nearby locations
curl --request GET \
  --url https://www.closient.com/locations/api/v1/public/locations \
  --header 'X-API-Key: <api-key>'
{
  "locations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "address": "<string>",
      "lat": 123,
      "lon": 123,
      "distance_km": 123,
      "public_id": "<string>",
      "phone": "",
      "website": ""
    }
  ],
  "organization": {
    "name": "<string>",
    "public_id": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
lat
number
required

Latitude of the search centre.

​
lon
number
required

Longitude of the search centre.

​
radius
number
default:50

Search radius in kilometres (default 50).

​
limit
integer
default:20

Maximum number of results (default 20, max 100).

Required range: 1 <= x <= 100

Response

200 - application/json

OK

​
locations
LocationOut · object[]
required
​
organization
OrganizationOut · object
required
Example:
{
  "name": "Acme Retail Corp.",
  "public_id": "acme-retail"
}