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

stateCodenullable

countrystring

zipcodestring

latnullable

lngnullable

googlePlaceIdnullable

createdAtstring

updatedAtstring

objectstringrequired

pageintegerrequired

totalPagesintegerrequired

perPageintegerrequired

totalCountintegerrequired

hasNextPagebooleanrequired

metaobjectrequired

requestIdstringrequired

Example: returns_the_owner's_locations

{
  "data": [
    {
      "object": "location",
      "id": "186ebd3b-baaa-43e0-be7f-834771fcd483",
      "name": "Downtown Hall",
      "address": "456 Oak Ave",
      "city": "Brooklyn",
      "state": "New York",
      "stateCode": null,
      "country": "US",
      "zipcode": "11201",
      "lat": null,
      "lng": null,
      "googlePlaceId": null,
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    },
    {
      "object": "location",
      "id": "7a032daf-0999-4e23-8ef5-dfd2fb0c5097",
      "name": "Main Studio",
      "address": "123 Main St",
      "city": "New York",
      "state": "New York",
      "stateCode": null,
      "country": "US",
      "zipcode": "10001",
      "lat": null,
      "lng": null,
      "googlePlaceId": null,
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00"
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 2,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_401

{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}