v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Locations

Retrieve single location.

Required scopes: flex.space.locations.read

get/api/v2/organizations/{orgSlug}/locations/{locationId}

Path parameters

locationIdstring required

location id

orgSlugstring required

organization slug

Response

propertiesobject

An object that contains all custom properties that can be applied to the item.

_idstring

The _id of the location.

namestring

The name of the location.

timezonestring

The timezone of the location.

isOpenboolean

If true, the location is operational; if false or omitted, the location is not working - either not open yet, or suspended for some other reason.

isPublicboolean

If true, the location is shown in the members portal; if false or omitted the location is not displayed in the members portal.

imagestring

The URL pointing to an image assigned to this location.

codestring

A unique code of the location.

Example response

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "_id": "603dfbc260f4054084125d39",
  "name": "Location 1",
  "address": {
    "formattedAddress": "123 Main St",
    "country": "United States",
    "state": "California",
    "city": "San Francisco",
    "street": "Main St",
    "zip": "94105",
    "latitude": "37.7749",
    "longitude": "-122.4194"
  },
  "timezone": "UTC",
  "isOpen": true,
  "isPublic": true,
  "image": "//example.com/image.jpg",
  "code": "LOC123",
  "targetRevenuePerPeriod": [
    {
      "startDate": "2024-01-01T00:00:00.000Z",
      "endDate": "2024-12-31T23:59:59.999Z",
      "target": 50000
    }
  ]
}