Skip to main content
GET
/
admin
/
services
/
list
List Services
curl --request GET \
  --url https://api.decodahealth.com/admin/services/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "id": "<string>",
    "duration": 123,
    "name": "<string>",
    "color": "<string>",
    "bookingFee": 123,
    "numBookings": 123,
    "locationIds": [
      "<string>"
    ],
    "prepTimeDuration": 123,
    "prepTimeBuffer": 123,
    "prepTimeName": "<string>",
    "prepTimeColor": "<string>",
    "prepProviderIds": [
      "<string>"
    ],
    "bookables": [
      {
        "bookableId": "<string>",
        "startOffset": 0,
        "duration": 5040
      }
    ],
    "description": "<string>",
    "price": 123,
    "displayPrice": 123,
    "displayPriceMax": 123,
    "priceStartsAt": false,
    "cost": 123,
    "estimated": false,
    "bookingFeeText": "<string>",
    "reminderMinutesBefore": 1440,
    "cancellationCost": 0,
    "hoursBeforeCancellingCosts": 0,
    "bookingFeePercentage": 123,
    "cancellationFeePctWithin24h": 123,
    "cancellationFeePctWithin48h": 123,
    "refundBookingFeeBefore48h": false,
    "hoursBeforeBookingFeeRefundable": 123,
    "followUpMinutesAfter": 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>",
    "shortNoticeBlock": 123,
    "visibility": "ALL",
    "minutesBeforeRebookingAllowed": 123,
    "allowIndividualProviderBooking": true,
    "displayOrder": 0,
    "reservedTimeMinutes": 123,
    "category": "<string>",
    "isDoubleBookable": true,
    "isPopular": false,
    "onlyBookableOverThePhone": false,
    "creditCardRequired": false,
    "collectCreditCard": false,
    "autoGfeTreatments": [
      "<string>"
    ],
    "brandName": "<string>",
    "unit": "AMPOULES",
    "internalNotes": "<string>",
    "sortOrder": 123,
    "allowCustomPricing": false,
    "checklists": [
      {
        "name": "<string>",
        "position": 123,
        "id": "<string>",
        "type": "FILLED_FORM",
        "optional": false
      }
    ],
    "stocks": [
      {
        "itemId": "<string>",
        "stockId": "<string>",
        "quantityUsed": 123,
        "stock": {
          "name": "<string>",
          "unit": "AMPOULES",
          "id": "<string>",
          "description": "<string>",
          "notes": "<string>",
          "category": "<string>",
          "minStockLevel": 123,
          "isArchived": false,
          "shipments": [
            {
              "stockId": "<string>",
              "supplierId": "<string>",
              "locationId": "<string>",
              "quantity": 123,
              "remainingQuantity": 123,
              "locationName": "<string>",
              "id": "<string>",
              "poLineItemId": "<string>",
              "lotNumber": "<string>",
              "expiryDate": "2023-11-07T05:31:56Z",
              "sku": "<string>",
              "actualConversionFactor": 123,
              "cost": 123,
              "supplier": {
                "name": "<string>",
                "description": "<string>",
                "website": "<string>",
                "email": "<string>",
                "preferredContactMethod": "<string>",
                "phoneNumber": "<string>",
                "addressLineOne": "<string>",
                "addressLineTwo": "<string>",
                "city": "<string>",
                "state": "<string>",
                "zipCode": "<string>",
                "country": "<string>",
                "shipmentTime": 123,
                "isArchived": false,
                "defaultNotes": [
                  {
                    "content": "<string>",
                    "id": "<string>",
                    "supplierId": "<string>",
                    "name": "<string>"
                  }
                ],
                "id": "<string>"
              },
              "createdDate": "2023-11-07T05:31:56Z",
              "note": "<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

id
string
required
duration
integer
required
name
string
required
color
string
required
bookingFee
integer
required
numBookings
integer
required
locationIds
string[] | null
prepTimeDuration
integer | null
prepTimeBuffer
integer | null
prepTimeName
string | null
prepTimeColor
string | null
prepProviderIds
string[] | null
bookables
ServiceBookableItem · object[] | null
description
string | null
price
integer | null
displayPrice
integer | null
displayPriceMax
integer | null
priceStartsAt
boolean | null
default:false
cost
integer | null
estimated
boolean | null
default:false
bookingFeeText
string | null
reminderMinutesBefore
integer | null
default:1440
cancellationCost
integer | null
default:0
hoursBeforeCancellingCosts
integer | null
default:0
bookingFeePercentage
integer | null
cancellationFeePctWithin24h
integer | null
cancellationFeePctWithin48h
integer | null
refundBookingFeeBefore48h
boolean | null
default:false
hoursBeforeBookingFeeRefundable
integer | null
followUpMinutesAfter
integer | null
default:0
followUpSmsTemplate
string | null
providerIds
string[] | null
forms
FormTiny · object[] | null
createdDate
string<date-time> | null
updatedDate
string<date-time> | null
confirmationSmsTemplate
string | null
cancellationSmsTemplate
string | null
noShowSmsTemplate
string | null
overrideNoticeSmsTemplate
string | null
reminderSmsTemplate
string | null
shortNoticeBlock
integer | null
visibility
enum<string>
default:ALL
Available options:
ALL,
NEW,
EXISTING,
NO
minutesBeforeRebookingAllowed
integer | null
allowIndividualProviderBooking
boolean | null
displayOrder
integer | null
default:0
reservedTimeMinutes
integer | null
category
string | null
isDoubleBookable
boolean | null
default:true
onlyBookableOverThePhone
boolean | null
default:false
creditCardRequired
boolean | null
default:false
collectCreditCard
boolean | null
default:false
autoGfeTreatments
string[] | null
brandName
string | null
unit
enum<string> | null
Available options:
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 | null
sortOrder
integer | null
allowCustomPricing
boolean | null
default:false
checklists
ServiceChecklistItem · object[] | null
stocks
ItemStockDetail · object[] | null