Service Object

The service object represents an offering that a business provides to its customers.

Properties
idstringRead-onlyformat GUID

Service ID.

typestring

Service type. Learn more about service types (SDK | REST).

sortOrderintegerformat int32

Order of the service within a category (SDK | REST).

namestringmaxLength 400minLength 1

Service name.

descriptionstringmaxLength 7000

Service description. For example, High-class hair styling, cuts, straightening and color.

tagLinestringmaxLength 6000

Short service description, such as Hair styling.

defaultCapacityintegerminimum 1maximum 1000format int32

Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity.

mediaMedia

Media associated with the service.

hiddenboolean

Whether the service is hidden from the site.

categoryCategory

Category (SDK | REST) the service is associated with.

formForm

Form the customer filled out when booking the service.

paymentPayment

Payment options for booking the service. Learn more about service payments (SDK | REST).

onlineBookingOnlineBooking

Online booking settings.

conferencingConferencing

Conferencing options for the service.

locationsArray <Location>maxItems 500

The locations this service is offered at. Read more about service locations (SDK | REST).

bookingPolicyBookingPolicy

Policy (SDK | REST) determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins.

scheduleSchedule

The service's schedule (SDK | REST), which can be used to manage the service's events (SDK | REST).

staffMemberIdsArray <string>maxItems 220format GUID

IDs of the staff members (SDK | REST) providing the service. Available only for appointment-based services.

serviceResourcesArray <ServiceResource>maxItems 3

Information about which resources must be available so customers can book the service. For example, a meeting room or equipment.

supportedSlugsArray <Slug>Read-onlymaxItems 100

A slug is the last part of the URL address that serves as a unique identifier of the service. The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.

mainSlugMainSlugRead-only

Active slug for the service. Learn more about service slugs (SDK | REST).

urlsUrlsRead-only

URLs to various service-related pages, such as the calendar page and the booking page.

extendedFieldsExtendedFields

Extensions enabling users to save custom data related to the service.

seoDataSeoData

Custom SEO data for the service.

createdDatestringRead-onlyformat date-time

Date and time the service was created in YYYY-MM-DDThh:mm:ss.sssZ format.

updatedDatestringRead-onlyformat date-time

Date and time the service was updated in YYYY-MM-DDThh:mm:ss.sssZ format.

revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the service is updated. To prevent conflicting changes, the existing revision must be used when updating a service.

Did this help?