Skip to main content
GET
/
calendar
/
self-schedule
/
front-page
Get Front Page
curl --request GET \
  --url https://api.decodahealth.com/calendar/self-schedule/front-page \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "services": [
    {
      "id": "<string>",
      "duration": 123,
      "name": "<string>",
      "color": "<string>",
      "bookingFee": 123,
      "locationIds": [
        "<string>"
      ],
      "description": "<string>",
      "price": 123,
      "displayPrice": 123,
      "costOfService": 0,
      "estimated": false,
      "bookingFeeText": "<string>",
      "reminderDaysBefore": 1,
      "cancellationCost": 0,
      "hoursBeforeCancellingCosts": 0,
      "bookingFeePercentage": 123,
      "cancellationFeePctWithin24h": 123,
      "cancellationFeePctWithin48h": 123,
      "refundBookingFeeBefore48h": false,
      "hoursBeforeBookingFeeRefundable": 123,
      "followUpDaysAfter": 0,
      "followUpSmsTemplate": "<string>",
      "providerIds": [
        "<string>"
      ],
      "forms": [
        {
          "id": "<string>",
          "name": "<string>",
          "pathName": "<string>"
        }
      ],
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "confirmationSmsTemplate": "<string>",
      "cancellationSmsTemplate": "<string>",
      "noShowSmsTemplate": "<string>",
      "overrideNoticeSmsTemplate": "<string>",
      "reminderSmsTemplate": "<string>",
      "selfSchedulingBufferTime": 123,
      "visibility": "ALL",
      "minutesBeforeRebookingAllowed": 123,
      "allowIndividualProviderBooking": true,
      "displayOrder": 0,
      "reservedTimeMinutes": 123,
      "category": "<string>",
      "isDoubleBookable": true,
      "isPopular": false,
      "creditCardRequired": false,
      "collectCreditCard": false,
      "autoGfeTreatments": [
        "<string>"
      ],
      "brandName": "<string>",
      "unit": "AMPOULES",
      "internalNotes": "<string>",
      "sortOrder": 123,
      "taxable": false,
      "allowCustomPricing": false
    }
  ],
  "providers": [
    {
      "id": "<string>",
      "type": "PROVIDER",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "locationId": "<string>",
      "profileImage": "<string>",
      "bio": "<string>"
    }
  ],
  "locations": [
    {
      "id": "<string>",
      "isVirtual": true,
      "name": "<string>",
      "timezone": "<string>",
      "addressLineOne": "<string>",
      "addressLineTwo": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "spakinectLocationId": "<string>",
      "description": "<string>",
      "phoneNumber": "<string>",
      "photoUrl": "<string>",
      "reviewLink": "<string>",
      "updatedDate": "2023-11-07T05:31:56Z",
      "latitude": 123,
      "longitude": 123,
      "taxes": []
    }
  ],
  "categories": [
    "<string>"
  ],
  "logoUrl": "<string>",
  "tenantName": "<string>",
  "phoneNumber": "<string>",
  "shouldExposePatientTypeChoice": true,
  "shouldExposeLocationTypeChoice": true,
  "slogan": "<string>",
  "shouldGroupServicesByLocation": false,
  "shouldGroupServicesByCategory": false,
  "googleTagManagerId": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Response

200 - application/json

Successful Response

services
ServiceDetail · object[]
required
providers
PublicProvider · object[]
required
locations
LocationDetail · object[]
required
categories
string[]
required
logoUrl
string
required
tenantName
string
required
phoneNumber
string
required
shouldExposePatientTypeChoice
boolean
required
shouldExposeLocationTypeChoice
boolean
required
slogan
string | null
shouldGroupServicesByLocation
boolean
default:false
shouldGroupServicesByCategory
boolean
default:false
googleTagManagerId
string | null