---
title: "Get Location"
method: GET
path: "/setup/v1/locations/{id}"
tags: ["Locations"]
---

# Get Location

`GET /setup/v1/locations/{id}`

Use this endpoint to return a **Location** object. A valid **location id** is required. If not specified, the business location defaults to the primary business location. Find all business location id's, by using the _GET /consumer/v1/locations_ endpoint.

**IMPORTANT DEPRECATION NOTICE**: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on **OCTOBER 15, 2022**. These fields are currently part of the **SETTINGS** object in all location endpoints: **businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav.** If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: **_support@onsched.com_** as we do not want to interrupt your existing workflows.

## Path parameters

- `id` string, required

## Response `200`

Success

- LocationViewModel
  - `object` string, nullable
  - `id` string, nullable
  - `friendlyId` string, nullable
  - `companyId` string, nullable
  - `companyName` string, nullable
  - `name` string, nullable
  - `adminEmail` string, nullable
  - `adminName` string, nullable
  - `phone` string, nullable
  - `fax` string, nullable
  - `email` string, nullable
  - `website` string, nullable
  - `regionId` string, nullable
  - `logo` string, nullable
  - `imageUrl` string, nullable
  - `timezoneId` string, nullable
  - `timezoneIana` string, nullable
  - `timezoneOffset` integer, nullable
  - `primaryBusiness` boolean
  - `primaryCalendarId` string, nullable
  - `latitude` number, double
  - `longitude` number, double
  - `travel` TravelViewModel
    - `startAddress` string, nullable
    - `startLat` string, nullable
    - `startLon` string, nullable
    - `distance` string, nullable
    - `proximity` string, nullable
    - `units` string, nullable
  - `address` AddressViewModel
    - `addressLine1` string, nullable
    - `addressLine2` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `postalCode` string, nullable
  - `businessHours` BusinessHoursViewModel
    - `mon` BusinessHourViewModel
      - `isOpen` boolean
      - `startTime` integer
      - `endTime` integer
      - `is24Hours` boolean
    - `tue` BusinessHourViewModel
      - `isOpen` boolean
      - `startTime` integer
      - `endTime` integer
      - `is24Hours` boolean
    - `wed` BusinessHourViewModel
      - `isOpen` boolean
      - `startTime` integer
      - `endTime` integer
      - `is24Hours` boolean
    - `thu` BusinessHourViewModel
      - `isOpen` boolean
      - `startTime` integer
      - `endTime` integer
      - `is24Hours` boolean
    - `fri` BusinessHourViewModel
      - `isOpen` boolean
      - `startTime` integer
      - `endTime` integer
      - `is24Hours` boolean
    - `sat` BusinessHourViewModel
      - `isOpen` boolean
      - `startTime` integer
      - `endTime` integer
      - `is24Hours` boolean
    - `sun` BusinessHourViewModel
      - `isOpen` boolean
      - `startTime` integer
      - `endTime` integer
      - `is24Hours` boolean
  - `businessHolidays` BusinessHolidayViewModel[], nullable
    - `id` string, nullable
    - `holidayName` string, nullable
    - `businessClosed` boolean
    - `publicHolidayId` integer
  - `services` BusinessServiceViewModel[], nullable
    - `object` string, nullable
    - `id` integer
    - `serviceId` integer
    - `serviceName` string, nullable
  - `settings` OnlineSettingsViewModel
    - `object` string, nullable
    - `companyId` string, nullable
    - `businessId` string, nullable
    - `locationId` string, nullable
    - `enabled` boolean
    - `familyMembersEnabled` boolean
    - `customerVerification` boolean
    - `serviceLabel` string, nullable
    - `resourceSelection` boolean
    - `resourceLabel` string, nullable
    - `resourceAnyLabel` string, nullable
    - `id` integer
    - `defaultService` boolean, nullable
    - `liveMode` boolean, nullable
    - `firstAvailable` boolean, nullable
    - `formFlow` integer
    - `availabilityForm` integer
    - `showServiceGroups` boolean
    - `bookWithAccount` boolean
    - `bookingPolicy` string, nullable
    - `bookingMessage` string, nullable
    - `showOnSchedLogo` boolean
    - `showBusinessLogo` boolean
    - `enableWorldTimezones` boolean, nullable
    - `disableAuthorization` boolean, nullable
    - `hideNavBar` boolean, nullable
    - `hideLocationNav` boolean, nullable
    - `hideServiceGroupsNav` boolean, nullable
    - `hideServicesNav` boolean, nullable
    - `hideContinueBooking` boolean, nullable
    - `defaultToCustomerTimezone` boolean
    - `returnToService` boolean
    - `returnToAvailability` boolean
    - `hideBreadCrumbNav` boolean
    - `bookingTimerMins` integer
    - `bookAheadUnit` integer
    - `bookAheadValue` integer
    - `bookInAdvance` integer
    - `customerBookingsPerDay` integer
    - `lateCancelHours` integer
    - `lateCancelAction` integer
    - `lateRescheduleHours` integer
    - `lateRescheduleAction` integer
    - `bookingConfirmationMessage` string, nullable
  - `defaults` BusinessDefaultsViewModel
    - `object` string, nullable
    - `enableUtcTimezone` boolean, nullable
    - `customerState` boolean, nullable
    - `customerCity` boolean, nullable
    - `autoUpdateCustomer` boolean, nullable
    - `businessNotification` boolean, nullable
    - `emailInfo` boolean, nullable
  - `appointmentReminders` AppointmentReminderViewModel
    - `emailFirstReminder` integer
    - `emailFirstReminderInterval` integer
    - `emailSecondReminder` integer
    - `emailSecondReminderInterval` integer
    - `smsFirstReminder` integer
    - `smsFirstReminderInterval` integer
    - `smsSecondReminder` integer
    - `smsSecondReminderInterval` integer

---

[API](https://skmtc.net/onsched/apis/onsched-setup-api.md) · [All operations](https://skmtc.net/onsched/apis/onsched-setup-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onsched/onsched-setup-api/versions/c5c023458a2f/schema)