Get location

GET 
/locations/:id

Get location

Request

Path Parameters

idstringrequired
Example: 00000000-0000-0000-0000-000000000000

200

Returns the location

objectstringrequired

idstringrequired

namestringrequired

addressstringrequired

citystringrequired

statestringrequired

stateCodenullablerequired

countrystringrequired

zipcodestringrequired

latnullablerequired

lngnullablerequired

googlePlaceIdnullablerequired

createdAtstringrequired

updatedAtstringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_the_location

{
  "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",
  "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"
  }
}

404

Returns 404 for non-existent location

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_404_for_non-existent_location

{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}