Skip to main content
GET
/
v1
/
locations
List locations
curl --request GET \
  --url https://api.myhamlet.com/v1/locations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "uuid": "5f2b0c3a-1d4e-4a8b-9f6d-2a1c3e4b5d6f",
      "type": "CITY",
      "name": "Palo Alto",
      "state_name": "California",
      "state_abbreviation": "CA",
      "county_names": [
        "Santa Clara"
      ],
      "created_at": "2025-01-10T00:00:00.000Z",
      "updated_at": "2026-05-01T18:22:10.000Z"
    }
  ],
  "next_cursor": "eyJ1IjoiMjAyNi0wNS0wMSAxODoyMjoxMCIsImkiOjQyfQ"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
per_page
integer
default:50

Maximum number of items to return per page.

Required range: 1 <= x <= 100
Example:

50

​
cursor
string

Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.

Example:

"eyJ1IjoiMjAyNi0wNS0wMSAxODoyMjoxMCIsImkiOjQyfQ"

​
updated_since
string<date-time>

Inclusive lower bound on updated_at (ISO-8601 with a UTC Z or numeric offset, e.g. 2026-05-01T18:22:10Z). Returns only records changed at or after this time, ordered and paged exactly like a normal request — pass it alongside cursor to sync incrementally. A malformed or offset-less timestamp returns 400.

Example:

"2026-05-01T18:22:10Z"

Response

A page of entitled locations.

​
data
object[]
required
​
next_cursor
string | null
required

Pass as cursor to fetch the next page; null when there are no more results.

Example:

"eyJ1IjoiMjAyNi0wNS0wMSAxODoyMjoxMCIsImkiOjQyfQ"