---
title: "Get Front Page"
method: GET
path: "/calendar/self-schedule/front-page"
tags: ["provider", "calendar", "self-schedule", "public"]
---

# Get Front Page

`GET /calendar/self-schedule/front-page`

## Request

- Base URL: `https://docs.decodahealth.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.decodahealth.com/calendar/self-schedule/front-page`
- Auth: none declared. Required headers: `TENANT`, `API-KEY`
- TypeScript: <https://skmtc.dev/decodahealth/apis/decoda-api/docs/calendar/self-schedule/front-page/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- FrontPage
  - `services` ServiceDetail[], required
    - `id` string, required
    - `duration` integer, required
    - `name` string, required
    - `locationIds` string[], nullable
    - `color` string, required
    - `description` string, nullable
    - `price` integer, nullable
    - `displayPrice` integer, nullable
    - `costOfService` integer
    - `estimated` boolean, nullable
    - `bookingFee` integer, required
    - `bookingFeeText` string, nullable
    - `reminderDaysBefore` integer, nullable
    - `cancellationCost` integer, nullable
    - `hoursBeforeCancellingCosts` integer, nullable
    - `bookingFeePercentage` integer, nullable
    - `cancellationFeePctWithin24h` integer, nullable
    - `cancellationFeePctWithin48h` integer, nullable
    - `refundBookingFeeBefore48h` boolean, nullable
    - `hoursBeforeBookingFeeRefundable` integer, nullable
    - `followUpDaysAfter` integer, nullable
    - `followUpSmsTemplate` string, nullable
    - `providerIds` string[], nullable
    - `forms` FormTiny[], nullable
      - `id` string, required
      - `name` string, required
      - `pathName` string, required
    - `createdDate` string, date-time, nullable
    - `updatedDate` string, date-time, nullable
    - `confirmationSmsTemplate` string, nullable
    - `cancellationSmsTemplate` string, nullable
    - `noShowSmsTemplate` string, nullable
    - `overrideNoticeSmsTemplate` string, nullable
    - `reminderSmsTemplate` string, nullable
    - `selfSchedulingBufferTime` integer, nullable
    - `visibility` 'ALL' | 'NEW' | 'EXISTING' | 'NO'
    - `minutesBeforeRebookingAllowed` integer, nullable
    - `allowIndividualProviderBooking` boolean, nullable
    - `displayOrder` integer, nullable
    - `reservedTimeMinutes` integer, nullable
    - `category` string, nullable
    - `isDoubleBookable` boolean, nullable
    - `isPopular` boolean, nullable
    - `creditCardRequired` boolean, nullable
    - `collectCreditCard` boolean, nullable
    - `autoGfeTreatments` string[], nullable
    - `brandName` string, nullable
    - `unit` 'AMPOULES' | 'APPLICATORS' | 'BOTTLES' | 'BOXES' | 'CAPSULES' | 'CUPS' | 'DOSES' | 'G_PER_ML' | 'GRAMS' | 'IU' | 'IU_PER_ML' | 'OUNCES' | 'FLUID_OUNCES' | 'KG' | 'KITS' | 'LITERS' | 'MCG' | 'MG' | 'MG_PER_ML' | 'ML' | 'MMOL' | 'MICROGRAM_PER_ML' | 'PACKS' | 'PAIRS' | 'PATCHES' | 'PERCENTAGE' | 'PIECES' | 'POUCHES' | 'ROLLS' | 'SACHETS' | 'SHEETS' | 'SPRAYS' | 'STRIPS' | 'SYRINGES' | 'TABLETS' | 'TABLETS_PER_DAY' | 'TESTS' | 'TUBES' | 'UNITS' | 'VIALS' | 'TREATMENTS' | 'SESSIONS' | 'PULSES' | 'JOULES' | 'CENTIMETERS' | 'THREAD_COUNT' | 'INJECTIONS' | 'WRINKLE_UNITS' | 'POUNDS' | 'FEET' | 'INCHES'
    - `internalNotes` string, nullable
    - `sortOrder` integer, nullable
    - `taxable` boolean, nullable
    - `allowCustomPricing` boolean, nullable
  - `providers` PublicProvider[], required
    - `id` string, required: The unique identifier for the user.
    - `firstName` string, nullable: The user's first name.
    - `lastName` string, nullable: The user's last name.
    - `phoneNumber` string, nullable: The user's phone number.
    - `email` string, nullable: The user's email address.
    - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
    - `locationId` string, nullable: The location of the user.
    - `profileImage` string, nullable
    - `bio` string, nullable
  - `locations` LocationDetail[], required
    - `id` string, required
    - `isVirtual` boolean, required
    - `name` string, required
    - `addressLineOne` string, nullable
    - `addressLineTwo` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `zipCode` string, nullable
    - `country` string, nullable
    - `createdDate` string, date-time, nullable
    - `spakinectLocationId` string, nullable
    - `description` string, nullable
    - `phoneNumber` string, nullable
    - `photoUrl` string, nullable
    - `reviewLink` string, nullable
    - `timezone` string, required
    - `updatedDate` string, date-time, nullable
    - `latitude` number, nullable
    - `longitude` number, nullable
    - `taxes` TaxSummary[]
      - `id` string, required: Unique identifier for the tax
      - `name` string, required: Name of the tax (e.g., 'Sales Tax', 'VAT')
      - `percentage` number, required: Tax percentage (e.g., 8.25 for 8.25%)
      - `location_id` string, required: Location this tax applies to
  - `categories` string[], required
  - `logoUrl` string, required
  - `tenantName` string, required
  - `phoneNumber` string, required
  - `slogan` string, nullable
  - `shouldExposePatientTypeChoice` boolean, required
  - `shouldExposeLocationTypeChoice` boolean, required
  - `shouldGroupServicesByLocation` boolean
  - `shouldGroupServicesByCategory` boolean
  - `googleTagManagerId` string, nullable

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)