The Facility object

Attributes

  • facility_id string required

    Unique identifier for the facility.

  • org_id string required

    Unique identifier for the parent organisation.

  • name string required

    Facility name.

  • brand string optional

    Brand name used by the facility.

  • website_url string optional

    Facility website URL.

  • place_data object optional

    Location data from Google Places API containing country, formatted address, Google Place ID, province, and city.

  • social_links object optional

    Social media links for the facility.

  • timezone string optional

    IANA timezone identifier (e.g., "Australia/Sydney", "America/New_York").

The Facility object

{
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  "org_id": "00000000-0000-0000-0000-000000000050",
  "name": "FitLife Downtown",
  "brand": "FitLife",
  "website_url": "https://fitlife.com/downtown",
  "social_links": {
    "instagram": {
      "handle": "@fitlifedowntown"
    },
    "facebook": {
      "handle": "FitLifeDowntown"
    }
  },
  "place_data": {
    "country": {
      "iso_code": "AU",
      "full_name": "Australia"
    },
    "formatted_address": "123 Main Street, Suite 100, Sydney NSW 2000, Australia",
    "google_place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
    "province": {
      "abbreviation": "NSW",
      "full_name": "New South Wales"
    },
    "city": {
      "short_name": "Sydney",
      "full_name": "Sydney"
    }
  },
  "timezone": "Australia/Sydney"
}