R
Rankup

Locations API

List locations

Retrieve all locations for a specific client.

GET /api/locations?clientId=CLIENT_ID

Parameters

ParameterTypeRequiredDescription
clientIdstring (UUID)YesThe client to list locations for

Response

[
  {
    "id": "uuid",
    "name": "Downtown Austin",
    "address": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "zip": "78701",
    "country": "US",
    "health_score": 82,
    "health_status": "green",
    "created_at": "2026-01-15T10:30:00Z"
  }
]

Bulk import locations

Import multiple locations from structured data (typically parsed from CSV).

POST /api/locations/upload
Content-Type: application/json

{
  "clientId": "CLIENT_ID",
  "rows": [
    {
      "name": "Downtown Austin",
      "address": "123 Main St",
      "city": "Austin",
      "state": "TX",
      "zip": "78701",
      "country": "US",
      "google_place_id": "ChIJ..."
    }
  ]
}

Request body

FieldTypeRequiredDescription
clientIdstring (UUID)YesThe client to add locations to
rowsarrayYesArray of location objects
rows[].namestringYesLocation name
rows[].addressstringNoStreet address
rows[].citystringNoCity
rows[].statestringNoState or province
rows[].zipstringNoPostal code
rows[].countrystringNoCountry code
rows[].google_place_idstringNoGoogle Place ID

Response

{
  "success": true,
  "count": 3,
  "locations": [
    { "id": "uuid", "name": "Downtown Austin", "city": "Austin", "state": "TX" }
  ]
}