Skip to main content

This page is also available as plain markdown · OpenAPI spec

List locations

GET 

/locations

List locations

Request

Query Parameters

    pageinteger
    Example: 1
    perPageinteger
    Example: 1

200

Returns the owner's locations
dataobject[]required
objectstring
idstring
namestring
addressstring
citystring
statestring
stateCodestring
countrystring
zipcodestring
latnullable
lngnullable
googlePlaceIdnullable
createdAtstring
updatedAtstring
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
Example: returns_the_owner's_locations
{
  "data": [
    {
      "object": "location",
      "id": "96f2320c-ce1b-47b4-a42f-ba821caa04e2",
      "name": "Downtown Hall",
      "address": "456 Oak Ave",
      "city": "Brooklyn",
      "state": "New York",
      "stateCode": "NY",
      "country": "US",
      "zipcode": "12401",
      "lat": null,
      "lng": null,
      "googlePlaceId": null,
      "createdAt": "2026-03-24T16:09:55Z",
      "updatedAt": "2026-03-24T16:09:55Z"
    },
    {
      "object": "location",
      "id": "81408d47-8acb-4b7c-803f-5d6d1c5f1dae",
      "name": "Main Studio",
      "address": "123 Main St",
      "city": "New York",
      "state": "New York",
      "stateCode": "NY",
      "country": "US",
      "zipcode": "12401",
      "lat": null,
      "lng": null,
      "googlePlaceId": null,
      "createdAt": "2026-03-24T16:09:55Z",
      "updatedAt": "2026-03-24T16:09:55Z"
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 2,
  "hasNextPage": false
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required"
}