Services

The Services API is used to access, create, and modify the reasons on your business' account, as services are commonly referred to as reasons on the TimeTap site. The Services API is connected to the Locations and Staff APIs, in that reasons can be optionally filtered depending on which staff and/or location was chosen for an appointment. Since reasons are necessary for creating appointments, as well as setting up class schedules, it is crucial for you to familiarize yourself with how to get, create, and update the different reasons on your account.

Reasons are made accessible to all users on a business's account, but staff members will only be able to create appointments for services to which they are assigned, unless that staff person is an admin.

On this page

1 Services API Endpoints
2 Services API Parameters
3 Service API Request Body/Payloads
4 Services API Responses
5 Services Object Values

Services API Endpoints

Return to Top

These are the endpoints that are available under the /services path, which lists all the different services your business offers using TimeTap.

`Endpoint`	`Description`

`Endpoint`	`Description`
GET /services	Returns all reason objects on an account in array format. If the user has admin privileges, he will see all services at all locations under his or her business, location Super Users see all services at their location, while users with User privileges will only see their own services.
GET /services/{reasonId}	Returns a JSON object for specified reason.
GET /services/{reasonId}/serviceStaff	Returns an array of data objects for active staff members who are allowed to offer the specified service. If the active property is set to true, the staff is allowed to offer the service, and if it is set to false, they not allowed to offer the service.
GET /services/{reasonId}/quota	Returns a number of how many appointments have been set as the quota for that specific reasonId on the date provided by the parameter.
GET /reasonList/reportWithCount	Returns an object that contains a list of reasons along with a count of the total number of reasons that match the parameters passed with the call.
GET /reasonList/report	Returns an object that contains a list of reasons that match the parameters passed with the call.
GET /reasonList/reportCount	Returns a count object that provides the number of reasons that match the parameters passed with the call.
GET /reasonIdList	Returns a list of reasonIds available on the account. If no parameters are passed, it will just return all active reasonIds on the account.
POST /services	Creates a new reason by passing a reason object with all required properties properly configured. Request body/payload: Must pass a reason object in the request body/payload. For these calls, you need to pass a services object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a services object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
POST /services/{reasonId}/serviceStaff	Updates the array for specified reasonId to allow more staff members to offer that reason or service by simply changing the active property accordingly. Request body/payload: Must pass a reason object in the request body/payload.
PUT /services/{reasonId}	Updates specified reason with any new values you may have changed on the properties. Request body/payload: Must pass a reason object with the desired changes made in the request body/payload. For these calls, you need to pass a services object with all required fields and any fields you want to update filled in the body of the payload. We have an example of a services object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
DELETE /services/{reasonId}	Deletes a reason or service by setting its active property to false. Open appointments for the service will not be deleted, but clients will no longer be able to schedule new appointments for the service.

Services API Parameters

Return to Top

Data points passed on in the request URL portion of the API call that are used to filter the data being requested. All services parameters are associated with the GET /services endpoint only.

Parameter	Type	Endpoints to be used with	Description

Parameter	Type	Endpoints to be used with	Description
addToAllGroups	boolean	POST /services	If set to true, the specified service will be added to all reason groups upon creation.
calendarIdList	integer array	GET /reasonIdList	Should be set as a comma-separated list of the calendarIds which will then return a unique set of reasonIds assigned to passed calendarId parameter.
classesOnly	boolean	GET /services	If set to true, only reasons of reasonType = CLASS will return. If passed as false, only reasons with a different reasonType will return.
date	string	GET /services/{reasonId}/quota	Should be set as the date that you want to see a services' quota for.
dateRangeType	string	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Used in conjunction with endDate and startDate parameters. Acceptable values are: createdDate (default) and modifiedDate. If all three parameters are passed, then the API will only return reasonIds that fall within the defined date range based on the dateRangeType selected here.
endDate	string	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Used in conjunction with dateRangeType and startDate parameters. Date should be set in format of YYYY-MM-DD. If all three parameters are passed, then the API will only return reasonIds that fall within the defined date range based on the dateRangeType that is being looked for.
excludeAddOns	boolean	GET /reasonIdList	If not passed or passed as true, only reasons whose reasonType property is not set to ADDON will return. If passed as false, then reasonIds for reasons of reasonTypes including ADDON will return.
excludeClasses	boolean	GET /services	If set to true, only reasons where reasonType is not CLASS will return. If passed as false, then all reasonTypes will return, including reasons where reasonType = CLASS.
excludePersonal	boolean	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	If set to true, will prevent reasons of reasonType = PERSONAL from returning.
inactive	boolean	GET /services	Should be set as false if you want active services to return.
includePersonal	integer	GET /services	Can be set to either 0 or 1. If set to 0, the call will return with only SERVICE, CLASS, and COURSE reasonTypes. If set to 1, the call will return with SERVICE, CLASS, COURSE, and PERSONAL reasonType.
locationGroupIdList	integer array	GET /reasonIdList	If you pass the groupId of an active location group on your account, only reasons that are bookable at the locations within that group will return.
locationId	string	GET /services	Returns an array of all reasons offered at a location. If reasonType = SERVICE, service availability is dependent on whether staff members that can offer the service have working hours at the location and if the service’s location specific availability has the location selected. If reasonType = CLASS, availability is dependent on whether the location has dates and times set up for it on its class schedule. If reasonType = COURSE, availability is dependent on whether the location has the course sets set up.
locationIdList	integer array	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Should be set as a comma-separated list of locationIds and will only return reasonIds that are bookable at the passed locationIds.
onlyAddOns	boolean	GET /reasonIdList	If set to true, only reasons whose reasonType property is set to ADDON will return. If not passed or passed as false, then no check is made to exclude reasonTypes other than ADDON.
onlyPersonal	boolean	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	If set to true, will only return reasons of reasonType = PERSONAL.
order_field	string	GET /reasonList/reportWithCount, GET /reasonList/report	Displays the field name used to order the data that gets returned following a GET call. The default used if nothing gets passed here is to sort based on the professionalId property.
order_mode	string	GET /reasonList/reportWithCount, GET /reasonList/report	Displays the order type that is used to order the data that gets returned following a GET call. Available options are "asc" for ascending and "desc" for descending.
pageNumber	integer	GET /reasonList/reportWithCount, GET /reasonList/report	Works with the pageSize parameter to determine how data gets returned following a GET call. The pageNumber value represents the number of pages on which the reasons that get returned appear.
pageSize	integer	GET /reasonList/reportWithCount, GET /reasonList/report	Works with the pageNumber parameter to determine how data gets returned following a GET call. The pageSize value represents the number of reasons appearing on each page of reasons that gets returned.
reasonIdList	integer array	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Should be set as a comma-separated list of the reasonIds connected to the reasons to return following the API call. Only active reasonIds that match any other parameter criteria should return.
reasonIdListToExclude	integer array	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Should be set as a comma-separated list of the reasonIds connected to the reasons that will not return following the API call.
reasonIdListToGetAddOnsFor	integer array	GET /reasonIdList	Should be set as a comma-separated list of the reasonIds to get reason add ons for. This parameter is used to get the reasonIds for the add ons assigned to specific reasons. For instance, say you have a reason of reasonType SERVICE with a reasonId of 12345, and a reason of reasonType CLASS with a reasonId of 67890. If you pass "12345,67890" in the reasonIdListToGetAddOnsFor then the reasonIds that return should be the reasonIds representing the addOns assigned to that SERVICE and CLASS.
reasonGroupIdList	integer array	GET /reasonIdList	Should be set as a comma-separated list of groupIds representing group objects of groupType SERVICE and will return the list of reasonIds that are in the reason group.
reasonTypeList	string array	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Should be set as a comma-separated list of the reasonTypes of the appointments to return following the API call. Acceptable values include: SERVICE, CLASS, COURSE, ADDON, PERSONAL.
searchTerm	string	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	String value which is used to identify only reasons who have a match for that searchTerm in their `reasonDesc`, `internalName`, or `reasonDetail` properties.
staffId	integer	GET /services	Returns an array of services offered by a certain staff member.
staffIdList	integer array	POST /services, GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	For POST /services endpoint - Automatically assigns the service being created to the staffIds being passed. The staffIdList should be passed as a comma separated list. For GET /reasonIdList and GET /reasonList calls - Should be set as a comma-separated list of professionalIds representing staff objects on your account. Will return only reasonIds that the staff passed in the API call offers.
startDate	string	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Used in conjunction with dateRangeType and endDate parameters. Date should be set in format of YYYY-MM-DD. If all 3 parameters are passed, then the API will only return reasonIds that fall within the defined date range based on the dateRangeType that is being looked for.
statusList	string	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	Should be set as a comma-separated list of the reason statuses connected to the reasons to return following the API call. Can be set as ACTIVE, DEACTIVE, and DELETED. The default used if no value is passed here is ACTIVE.
waitListOnly	boolean	GET /reasonList/reportWithCount, GET /reasonList/report, GET /reasonList/reportCount, GET /reasonIdList	If set to true, only reasons with `allowWaitlist` set to true will return. If you pass false (default), then no check is made on the `allowWaitlist` property.
working	boolean	GET /reasonIdList	Works in conjunction with the staffIdList and locationIdList parameters. If set to true, then only reasonIds that are offered at the passed locationIds and/or by the passed staffIds will return.

Service API Request Body/Payloads

Return to Top

{
    "accountHasReasonGroups": true,
    "active": true,
    "allOrNoneSelect": {
        "value": "all", 
        "label": "All Reason Groups"
    },
    "allowOnline": true,
    "bufferAfter": 30,
    "bufferBefore": 30,
    "business": 43111,
    "durationList": null,
    "hours": 8,
    "internalName": "Canine Care",
    "personal": false,
    "price": 350,
    "reasonDesc": "Dog Watching",
    "reasonType": "SERVICE",
    "screeningQuestion": null,
    "visitMinutes": 480
}

[{
    "active": true,
    "businessId": 43111,
    "cb": true,
    "createdDate": 1694717249749,
    "createdUser": "JoeSchmo",
    "description": "Coco moe",
    "modifiedDate": 1694717249855,
    "modifiedUser": "JoeSchmo",
    "price": null,
    "professionalId": 298660,
    "professionalServiceId": 5031028,
    "reasonId": 690754,
    "reasonType": null
}]

{
    "accepttips": null,
    "active": true,
    "addOnReasonIdList": null,
    "allowChoosePayAmount": true,
    "allowOnline": true,
    "allowPrePay": false,
    "allowRepeating": -1,
    "allowWaitList": true,
    "apptDayMax": 180,
    "apptHrMin": 0,
    "bookMultipleAppts": true,
    "bufferAfter": null,
    "bufferBefore": 15,
    "businessId": 43111,
    "clientTags": null,
    "color": null,
    "createdDate": 1534784959601,
    "createdUser": "JoeSchmo",
    "currencySymbol": null,
    "customFieldForm": null,
    "customWorkSchedule": 2,
    "depositAmount": null,
    "discountedPrice": null,
    "durationList": [
        "0": {
            "active": true,
            "deposit": null,
            "discountedPrice": null,
            "duration": 30,
            "durationName": "floofing",
            "internalName": null,
            "originalPrice": null,
            "price": null,
            "staffRateLevel": null
        },
        "1": {
            "active": true,
            "deposit": null,
            "discountedPrice": null,
            "duration": 60,
            "durationName": "shaving",
            "internalName": null,
            "originalPrice": null,
            "price": null,
            "staffRateLevel": null
    }],
    "emailInstructions": null,
    "emailInstructions2": null,
    "embedCode": "<iframe src='https://www.timetap.com/pembed/AOPMTjAkYf2' frameborder='0' width='840' height='500'> </iframe>",
    "formIdList": [6555],
    "imageUrl": null,
    "internalDisplayName": "Cat Grooming",
    "internalName": null,
    "maxWaitListPerClass": null,
    "modifiedDate": 1658237849315,
    "modifiedUser": "JoeSchmo",
    "multiDuration": true,
    "numberSessions": null,
    "parentReasonId": null,
    "personal": false,
    "price": null,
    "privateUrl": "https://www.timetap.com/appts/AOPMTjAkYf2",
    "professionalId": null,
    "professionalServiceList": null,
    "quota": null,
    "quotaFilled": null,
    "quotaType": null,
    "reasonDesc": "Cat Grooming",
    "reasonDetail": null,
    "reasonId": 255109,
    "reasonType": "SERVICE",
    "repeatingApptOptionList": null,
    "requirePayment": null,
    "requirePaymentChecked": false,
    "requirePaymentCheckedOriginalValue": false,
    "requirePreAuthPayment": false,
    "requirePreAuthPaymentChecked": false,
    "requirePreAuthPaymentCheckedOriginalValue": false,
    "requireStaffConfirmation": false,
    "rescheduleType": null,
    "salesforceValue": null,
    "screeningQuestion": null,
    "serviceLocations": [
        "0": {
            "active: true,
            "businessId": 43111,
            "createdDate": 1633010600176,
            "createdUser": "JoeSchmo",
            "description": "test",
            "locationId": 468322,
            "modifiedDate": 1658237849394,
            "modifiedUser": "JoeSchmo",
            "reasonId": 255109,
            "serviceLocationId": 4766389
        ],
    "showPayNowButton": true,
    "showPayNowButtonChecked": true,
    "showPayNowButtonCheckedOriginalValue": true,
    "sortWeight": null,
    "staffIdList": null,
    "status": "ACTIVE",
    "tags": null,
    "taxable": false,
    "visitMinutes": 0
}

Services API Responses

Return to Top

[{
	"accepttips": null,
    "active": true,
    "addOnReasonIdList": null,
    "allowChoosePayAmount": true,
	"allowOnline": true,
	"allowPrePay": false,
    "allowRepeating": -1,
	"allowWaitList": false,
    "apptDayMax": null,
    "apptHrMin": null,
    "bookMultipleAppts": null,
	"bufferAfter": 10,
    "bufferBefore": null,
    "businessId": 43111,
    "clientTags": null,
    "color": null,
    "createdDate": 1533915457063,
    "createdUser": "JoeSchmo",
    "currencySymbol": null,
    "customFieldForm": null,
    "customWorkSchedule": -1,
	"depositAmount": null,
	"discountedPrice": null,
    "durationList": null,
    "emailInstructions1": null,
    "emailInstructions2": null,
	"embedCode": null,
    "formIdList": null,
	"imageUrl": null,
    "internalDisplayName": "Dog Training",
	"internalName": null,
	"maxWaitListPerClass": null,
    "modifiedDate": 1674505456723,
	"modifiedUser": "JoeSchmo",
    "numberSessions": null,
    "parentReasonId": null,
	"personal": false,
	"price": 10,
    "privateUrl": null,
    "professionalId": null,
    "professionalServiceList": null,
	"quota": 3,
	"quotaFilled": 0,
    "quotaType": "day",
    "reasonDesc": "Dog Training",
    "reasonDetail": null,
    "reasonId": 240094,
    "reasonType": "SERVICE",
    "repeatingApptOptionList": null,
    "requirePayment": null,
    "requirePreAuthPayment": false,
    "requiresStaffConfirmation": true,
	"rescheduleType": null,
    "salesforceValue": null,
    "screeningQuestion": null,
	"serviceLocations": null,
    "showPayNowButton": true,
	"sortWeight": 0,
    "staffIdList": null,
    "status": "ACTIVE",
    "tags": null,
    "taxable": false,
    "visitMinutes": 60
}]

{
    "accepttips": null,
    "active": true,
    "addOnReasonIdList": null,
    "allowChoosePayAmount": true,
    "allowOnline": true,
    "allowPrePay": false,
    "allowRepeating": -1,
    "allowWaitList": false,
    "apptDayMax": null,
    "apptHrMin": null,
    "bookMultipleAppts": null,
    "bufferAfter": 5,
    "bufferBefore": 5,
    "businessId": 21345,
    "customWorkSchedule": 0,
    "depositAmount": null,
    "discountedPrice": null,
    "embedCode": null,
    "imageUrl": null,
    "internalDisplayName": "Underwater Basket Weaving",
    "internalName": null,
    "maxWaitListPerClass": null,
    "modifiedUser": "Jane Doe",
    "numberSessions": null,
    "personal": false,
    "price": 10,
    "quota": null,
    "quotaFilled": null,
    "quotaType": null,
    "reasonDesc": "Underwater Basket Weaving",
    "requiresStaffConfirmation": null,
    "rescheduleType": null,
    "screeningQuestion": null,
    "serviceLocations": null,
    "sortWeight": 0,
    "taxable": false,
    "visitMinutes": 60
}

[{
	"active": true,
    "businessId": 21345,
    "createdDate": 6678434353778,
    "createdUser": "JoeSchmo",
    "description": "Dr. J",
    "modifiedDate": null,
	"modifiedUser": null,
	"price": null,
    "professionalId": 298660,
    "professionalServiceId": 5031028,
    "reasonId": 690754,
    "reasonType": null
}]

{
    "reasons": [
    {
        "accepttips": null,
        "active": true,
        "addOnReasonIdList": null,
        "allowChoosePayAmount": false,
        "allowOnline": true,
        "allowPrePay": false,
        "allowRepeating": -1,
        "allowWaitList": false,
        "apptDayMax": null,
        "apptHrMin": null,
        "bookMultipleAppts": null,
        "bufferAfter": 5,
        "bufferBefore": 5,
        "businessId": 21345,
        "clientTags": null,
        "color": null,
        "createdDate": 1580318842509,
        "createdUser": "JoeSchmo",
        "currencySymbol": null,
        "currencyFieldForm": null,
        "customWorkSchedule": 0,
        "depositAmount": null,
        "discountedPrice": null,
        "durationList": null,
        "emailInstructions": null,
        "emailInstructions2": null,
        "embedCode": null,
        "formIdList": null,
        "imageUrl": null,
        "internalDisplayName": "Underwater Basket Weaving",
        "internalName": null,
        "maxWaitListPerClass": null,
        "modifiedDate": 1694708114823,
        "modifiedUser": "JoeSchmo",
        "numberSessions": null,
        "parentReasonId": null,
        "personal": false,
        "price": 10,
        "privateUrl": "https://www.timetap.com/appts/b09af1kjGt8",
        "professionalId": null,
        "professionalServiceList": null,
        "quota": null,
        "quotaFilled": null,
        "quotaType": null,
        "reasonDesc": "Underwater Basket Weaving",
        "reasonDetail": "",
        "reasonId": 12345,
        "reasonType": "SERVICE",
        "repeatingApptOptionList": null,
        "requirePayment": null,
        "requirePreAuthPayment": true,
        "requiresStaffConfirmation": false,
        "rescheduleType": null,
        "salesforceValue": null,
        "screeningQuestion": null,
        "serviceLocations": null,
        "showPayNowButton": false,
        "sortWeight": 0,
        "status": "ACTIVE",
        "tags": null,
        "taxable": false,
        "visitMinutes": 60
}],
    "count": 12}

[{
    "accepttips": null,
    "active": true,
    "addOnReasonIdList": null,
    "allowChoosePayAmount": false,
    "allowOnline": true,
    "allowPrePay": false,
    "allowRepeating": -1,
    "allowWaitList": false,
    "apptDayMax": null,
    "apptHrMin": null,
    "bookMultipleAppts": null,
    "bufferAfter": 5,
    "bufferBefore": 5,
    "businessId": 21345,
    "clientTags": null,
    "color": null,
    "createdDate": 1580318842509,
    "createdUser": "JoeSchmo",
    "currencySymbol": null,
    "customFieldForm": null,
    "customWorkSchedule": 0,
    "depositAmount": null,
    "discountedPrice": null,
    "durationList": null,
    "emailInstructions": null,
    "emailInstructions2": null,
    "embedCode": null,
    "formIdList": null,
    "imageUrl": null,
    "internalDisplayName": "Underwater Basket Weaving",
    "internalName": null,
    "maxWaitListPerClass": null,
    "modifiedDate": 1694708114823,
    "modifiedUser": "JoeSchmo",
    "numberSessions": null,
    "parentReasonId": null,
    "personal": false,
    "price": 10,
    "privateUrl": "https://www.timetap.com/appts/b09af1kjGt8",
    "professionalId": null,
    "professionalServiceList": null,
    "quota": null,
    "quotaFilled": null,
    "quotaType": null,
    "reasonDesc": "Underwater Basket Weaving",
    "reasonDetail": "Second edition had so many useless skills",
    "reasonId": 12345,
    "reasonType": "SERVICE",
    "repeatingApptOptionList": null,
    "requirePayment": null,
    "requirePreAuthPayment": true,
    "requiresStaffConfirmation": false,
    "rescheduleType": null,
    "salesforceValue": null,
    "screeningQuestion": null,
    "serviceLocations": null,
    "showPayNowButton": false,
    "sortWeight": 0,
    "staffIdList": null,
    "status": "ACTIVE",
    "tags": null,
    "taxable": false,
    "visitMinutes": 60
}]

{
    "count": 12
}

{
	"accepttips": null,
    "active": true,
    "addOnReasonIdList": null,
    "allowChoosePayAmount": null,
	"allowOnline": true,
	"allowPrePay": false,
    "allowRepeating": null,
	"allowWaitList": false,
    "apptDayMax": null,
    "apptHrMin": null,
    "bookMultipleAppts": null,
	"bufferAfter": 30,
    "bufferBefore": 30,
    "businessId": 43111,
    "clientTags": null,
    "color": null,
    "createdDate": 169471349652,
    "createdUser": "JoeSchmo",
    "currencySymbol": null,
    "customFieldForm": null,
    "customWorkSchedule": 0,
	"depositAmount": null,
	"discountedPrice": null,
    "durationList": null,
    "emailInstructions": null,
    "emailInstructions2": null,
	"embedCode": null,
    "formIdList": null,
	"imageUrl": null,
    "internalDisplayName": "Canine Care",
	"internalName": "Canine Care",
	"maxWaitListPerClass": null,
    "modifiedDate": 1694717249652,
	"modifiedUser": "JoeSchmo",
    "numberSessions": null,
    "parentReasonId": null,
	"personal": false,
	"price": 350,
    "privateUrl": null,
    "professionalId": null,
    "professionalServiceList": null,
	"quota": null,
	"quotaFilled": null,
    "quotaType": null,
    "reasonDesc": "Dog Watching",
    "reasonDetail": "<p>We look after your pups!</p>",
    "reasonType": "SERVICE",
    "repeatingApptOptionList": null,
    "requirePayment": null,
    "requirePreAuthPayment": null
    "requiresStaffConfirmation": null,
	"rescheduleType": null,
    "salesforceValue": null,
    "screeningQuestion": null,
	"serviceLocations": null,
    "showPayNowButton": null,
	"sortWeight": 0,
    "staffIdList": null,
    "status": "ACTIVE",
    "tags": null,
    "taxable": false,
    "visitMinutes": 90
}

[{
    "active": true,
    "businessId: 43111,
    "createdDate": 4476890812667,
    "createdUser": "JoeSchmo",
    "description": "Bahama Mama,
    "modifiedDate": 155677422,
    "modifiedUser": "JoeSchmo",
    "price": null,
    "professionalId": 302120,
    "professionalServiceId": 5031026,
    "reasonId": 690754,
    "reasonType": null
}]

{
	"accepttips": null,
    "active": true,
    "addOnReasonIdList": null,
    "allowChoosePayAmount": true,
	"allowOnline": true,
	"allowPrePay": false,
    "allowRepeating": -1,
	"allowWaitList": false,
    "apptDayMax": null,
    "apptHrMin": null,
    "bookMultipleAppts": true,
	"bufferAfter": null,
    "bufferBefore": null,
    "businessId": 43111,
    "clientTags": null,
    "color": null,
    "createdDate": 153478959501,
    "createdUser": "JoeSchmo",
    "customFieldForm": null,
    "customWorkSchedule": 0,
	"depositAmount": null,
	"discountedPrice": null,
    "durationList": [
        "0": {
            "active": true,
            "deposit": null,
            "discountedPrice": null,
            "duration": 30,
            "durationName": "floofing",
            "internalName": null,
            "originalPrice": null,
            "price": null,
            "staffRateLevel": null
        },
        "1": {
            "active": true,
            "deposit": null,
            "discountedPrice": null,
            "duration": 60,
            "durationName": "shaving",
            "internalName": null,
            "originalPrice": null,
            "price": null,
            "staffRateLevel": null
    }],
    "emailInstructions": null,
    "emailInstructions2": null,
    "embedCode": "<iframe src='https://www.timetap.com/pembed/AOPMTjAkYf2' frameborder='0' width='840' height='500'> </iframe>",
    "formIdList": [6555],
    "imageUrl": null,
    "internalDisplayName": "Cat Grooming",
    "internalName": null,
    "maxWaitListPerClass": null,
    "modifiedDate": 1658237849315,
    "modifiedUser": "JoeSchmo",
    "multiDuration": true,
    "numberSessions": null,
    "parentReasonId": null,
    "personal": false,
    "price": null,
    "privateUrl": "https://www.timetap.com/appts/AOPMTjAkYf2",
    "professionalId": null,
    "professionalServiceList": null,
    "quota": null,
    "quotaFilled": null,
    "quotaType": null,
    "reasonDesc": "Cat Grooming",
    "reasonDetail": null,
    "reasonId": 255109,
    "reasonType": "SERVICE",
    "repeatingApptOptionList": null,
    "requirePayment": null,
    "requirePaymentChecked": false,
    "requirePaymentCheckedOriginalValue": false,
    "requirePreAuthPayment": false,
    "requirePreAuthPaymentChecked": false,
    "requirePreAuthPaymentCheckedOriginalValue": false,
    "requireStaffConfirmation": false,
    "rescheduleType": null,
    "salesforceValue": null,
    "screeningQuestion": null,
    "serviceLocations": [
        "0": {
            "active: true,
            "businessId": 43111,
            "createdDate": 1633010600176,
            "createdUser": "JoeSchmo",
            "description": "test",
            "locationId": 468322,
            "modifiedDate": 1658237849394,
            "modifiedUser": "JoeSchmo",
            "reasonId": 255109,
            "serviceLocationId": 4766389
        ],
    "showPayNowButton": true,
    "showPayNowButtonChecked": true,
    "showPayNowButtonCheckedOriginalValue": true,
    "sortWeight": null,
    "staffIdList": null,
    "status": "ACTIVE",
    "tags": null,
    "taxable": false,
    "visitMinutes": 0
}

Services Object Values

Return to Top

Property name	Type	Required	Description

Property name	Type	Required	Description
accepttips	boolean		Indicates whether or not the specified service is set to accept tips.
active	boolean	Yes	Indicates whether or not the specified service should return on GET calls.
addOnReasonIdList	array		Provides the reason IDs of any add-on reasons assigned to the specified service.
allowChoosePayAmount	boolean		Indicates whether or not the specified service is set to allow clients to pay the deposit or the full amount upon booking.
allowOnline	boolean		Indicates whether or not the specified service is bookable on the scheduler or only on the back office.
allowPrePay	boolean		Indicates whether or not the customer will be able to pre-pay for the specified service through the scheduler if a payment gateway or PayPal is set up.
allowRepeating	integer		Indicates whether or not the specified service can be booked as a repeating appointment, where -1 means no and 0 means yes.
allowWaitList	boolean		Indicates whether or not the specified service allows the use of a waitlist.
apptDayMax	integer		Displays as the number of days in the future a client can book the specified service - this is known as the "Advanced Appointments" feature.
apptHrMin	integer		Displays as how close to the start of an appointment, in hours, a client can book the specified service - this is also known as the "Latest Appointment" feature.
bookMultipleAppts	boolean		Indicates whether or not clients can book multiple appointments of the specified service via the scheduler.
bufferAfter	integer		Time required after an appointment so appointments can’t be booked back-to-back; set in five minute increments.
bufferBefore	integer		Time required before an appointment so appointments can’t be booked back-to-back; set in five minute increments.
businessId	integer		Provides unique numerical ID for the business that offers the specified service.
clientTags	string		Displays all of the client tags associated with the specified service.
color	string		Displays the code for any color applied to the specified service.
createdDate	integer		Displays as the date the specified client's account was created, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string		Displays the username of user who created the specified client's account.
currencySymbol	string		Displays as the currency symbol used for the specified service.
customFieldForm
customWorkSchedule	integer		Can be set to 0, 1, or 2. This property corresponds to the serviceLocations property when set to either 0 or 2. If 0 the service is available at "All locations", if 2 the service is available at "Select locations", and if 1 the service has a custom work schedule. Only used for reasonType = SERVICE - for more info, see the Service Location API page.
depositAmount	integer		If the specified service has payment settings that include a deposit, this is the size of that deposit.
discountedPrice	string		Calculates any coupons or discounts and displays the new price here.
durationList	array		Can have either a single duration (stored under visitMinutes) or multiple durations the client can choose from. If it has multiple durations, then they are stored as objects in the durationList property. Only used for reasonType = SERVICE.
emailInstructions