These are the endpoints that are available under the /groups path, which lists all the different groups you have added to the locations or reasons on your business account for scheduling purposes.
Endpoint | Description |
|---|---|
GET /groups/list/{listType} | Returns all groups objects on an account in array format. The listType can be LOCATION or SERVICE. If listType is set to LOCATION, this endpoint will send back all groups on an account where groupType = LOCATION, and if listType is set to SERVICE, this endpoint will send back all groups on an account where groupType = SERVICE. |
GET /groups/{groupId} | Returns a JSON object for specified group. |
| POST /groups | Creates a new groups object on an account. Request body/payload: Must pass a full groups object in the request body/payload. For these calls, you need to pass a groups 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 groups object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| PUT /groups | Updates specified groups object. Request body/payload: Must pass a groups object with desired changes made in the request body/payload. For these calls, you need to pass a groups object with all the required fields and any fields you want to updated filled in in the body of the payload. We have an example of a groups object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| DELETE /groups/{groupId} | Removes a group object from view by setting its active property to false. |
Data points passed on in the request URL portion of the API call that are used to filter the data that is being requested.
| Parameter | Type | Endpoints to be used with | Description |
|---|---|---|---|
| working | boolean | GET /groups/list/{listType} | Returns only those groups that have availability defined in the group profile. |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[{ “active”"active": true, “allowOnline”"allOrNoneSelectLocations": {value: true"select", label: “businessId”: 43111"Select Locations"}, “createdDate”"businessId": 153149312223243111, "createdUsergroupItems": "JoeSchmo{active: true, objectType: "LOCATION", objectId: 87877}, “directions”: null "groupName": "Putty tats", “email”"groupType": null"LOCATION", "embedCodetimeZoneCode": null, } |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ “groupDescription”: "active"All of our aquatic classes": true, “groupId”"allowOnline": 29573true, "groupItemsbusinessId": [{ "active": true43111, "businessIdcode": 43111null, "createdDate": 15317485390771530107194592, "createdUser": "JoeSchmo", "groupItemIddirections": 227204null, "internalDisplayNameemail": "Wading"null, "modifiedDateembedCode": 1531748539077, "<iframe src='https://www.timetap.com/pembed/Z7kwFP2pUd' frameborder='0' width='840' height='500'></iframe>", "modifiedUsergroupDescription": "JoeSchmo",All of our aquatic classes", "objectIdgroupId": 16073429573, "objectTypegroupItemIds": "SERVICE"[177850], },{ "active": true, "groupItems": [{groupItemId: 306752, businessId: 43111, objectType: "SERVICE", objectId: 177850,…}], "businessIdgroupName": 43111"Aquatics", "createdDategroupType": 1531748539077"SERVICE", "createdUserinternalDisplayName": "JoeSchmoAquatics", "groupItemIdinternalName": 227203null, "internalDisplayName""itemNameList": ["Surfing for beginnersBeginners"], "logoUrl": null, "modifiedDate": 15317485390771549654674118, "modifiedUser": "JoeSchmo", "objectIdprivateUrl": 117850, "https://www.timetap.com/appts/Z7kwFP2pUd", "objectTypescreeningQuestion": "SERVICE"null, }]"sortWeight": null, "groupNametextSearchable": "Aquatics All of our aquatic classes", "groupTypetimezone": "SERVICE", null } |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[{ “internalDisplayName”“active”: "Aquatics"true, “internalName”“allowOnline”: nulltrue, "itemNameList": ["Surfing for beginners", "Wading"]“businessId”: 43111, “logoUrl”“createdDate”: null1531493122232, "modifiedDatecreatedUser": 1531748539077"JoeSchmo", "modifiedUser"“directions”: "JoeSchmo"null, “privateUrl”“email”: "https://www.timetap.com/appts/Z7kwFP2pUd"null, "screeningQuestionsembedCode": null, “sortWeight”“groupDescription”: null,"All of our aquatic “timeZoneCode”classes", “groupId”: null }] | ||||||||
| Code Block | ||||||||
| ||||||||
{29573, "groupItems": [{ “active”: true, “allowOnline”"active": true, “businessId” "businessId": 43111, “createdDate”: 1531493122232, "createdUsercreatedDate": "JoeSchmo"1531748539077, “directions”: null, "createdUser": "JoeSchmo", “email”: null, “embedCode: "<iframe src='https://www.timetap.com/pembed/gzvwUZQdH2' frameborder='0' width='840' height='500'> </iframe>",groupItemId": 227204, "groupDescriptioninternalDisplayName": "<p>OurWading", three primary offices</p>", "groupIdmodifiedDate": 311581531748539077, “groupItems” "modifiedUser": [{"JoeSchmo", "activeobjectId": true160734, "businessIdobjectType": 43111,"SERVICE" },{ "createdDateactive": 1531493122232true, "createdUserbusinessId": "JoeSchmo"43111, "groupItemIdcreatedDate": 2268731531748539077, "internalDisplayNamecreatedUser": "JoeSchmo"Office, 1 - America/New_York", "modifiedDategroupItemId": 1531493122232227203, "modifiedUserinternalDisplayName": "JoeSchmoSurfing for beginners", "objectIdmodifiedDate": 818771531748539077, "objectTypemodifiedUser": "LOCATION" }JoeSchmo", "activeobjectId": true117850, "businessIdobjectType": 43111,"SERVICE" }], "createdDategroupName": 1531493122232"Aquatics", "createdUsergroupType": "JoeSchmoSERVICE", “internalDisplayName”: "groupItemIdAquatics":, 226874, “internalName”: null, "internalDisplayNameitemNameList": ["OfficeSurfing 2for - America/New_York",beginners", "Wading"], “logoUrl”: null, "modifiedDate": 15314931222321531748539077, "modifiedUser": "JoeSchmo", "objectId": 81428“privateUrl”: "https://www.timetap.com/appts/Z7kwFP2pUd", "screeningQuestions": null, "objectType": "LOCATION" “sortWeight”: null, “timeZoneCode”: null },}] |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "active"“active”: true, “allowOnline”: true, "businessId" “businessId”: 43111, “createdDate”: 1531493122232, "createdDate": 1531493122232, "createdUser": "JoeSchmo", "groupItemId"“directions”: 226875null, "internalDisplayName": "Beach Office - America/New_York"“email”: null, “embedCode: "modifiedDate": 1531493122232, "<iframe src='https://www.timetap.com/pembed/gzvwUZQdH2' frameborder='0' width='840' height='500'> </iframe>", "modifiedUsergroupDescription": "JoeSchmo<p>Our three primary offices</p>", "groupId": 31158, "objectId"“groupItems”: 81181,[{ "objectTypeactive": "LOCATION"true, }], "groupNamebusinessId": "Primary Offices", 43111, "groupTypecreatedDate": "LOCATION"1531493122232, “internalDisplayName” "createdUser": "Da Big 3JoeSchmo", “internalName”: "Da Big 3"groupItemId": 226873, "itemNameListinternalDisplayName": ["Office 1 - America/New_York", "Office 2 - America/New_York", "Beach Office - America/New_York"], “logoUrl”: null "modifiedDate": 1531493122232, “modifiedDate”: 1531493122232, "modifiedUser": "JoeSchmo", “privateUrl”: "https://www.timetap.com/appts/J00qtMAUx",, "screeningQuestionobjectId": null81877, "sortWeight": null, "timeZoneCodeobjectType": {Timezone"LOCATION" object for timezone of location}, group-see timezones API} } | ||||||||
| Code Block | ||||||||
| ||||||||
{ “active”"active": true, "allowOnlinebusinessId": true43111, “businessId”: 43111, "codecreatedDate": null1531493122232, "createdDate": 1535049680026, "createdUser": "JoeSchmo", "directionsgroupItemId": null226874, "emailinternalDisplayName": "petzRus@noemail.comOffice 2 - America/New_York", "embedCodemodifiedDate": null1531493122232, “groupescription”: "<p>All of our pet related gigs in one group!</p>","modifiedUser": "JoeSchmo", "groupIdobjectId": 3623981428, "groupItemsobjectType": [{"LOCATION" }, "active": true, "businessId": 43111, "createdDate": 15350496800261531493122232, "createdUser": "JoeSchmo", "groupItemId": 237961226875, "internalDisplayName": "Pooch PrimpingBeach Office - America/New_York", "modifiedDate": 1535048100431531493122232, "modifiedUser": "JoeSchmo", "objectId": 15933081181, "objectType": "SERVICELOCATION" }],{ "activegroupName": true, "Primary Offices", "businessIdgroupType": 43111"LOCATION", “internalDisplayName”: "Da Big 3", "createdDate": 1535049680026, “internalName”: "Da Big 3", "createdUseritemNameList": "JoeSchmo["Office 1 - America/New_York", "Office 2 - America/New_York", "Beach Office - "groupItemId": 237962,America/New_York"], “logoUrl”: null, "internalDisplayName"“modifiedDate”: "Dog Training"1531493122232, "modifiedDatemodifiedUser": 153504810043, "JoeSchmo", “privateUrl”: "https://www.timetap.com/appts/J00qtMAUx",, "modifiedUserscreeningQuestion": "JoeSchmo"null, "objectIdsortWeight": 240094null, "objectTypetimeZoneCode": "SERVICE"{Timezone object for timezone },{of location group-see timezones API} } |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ “active”: true, "activeallowOnline": true, “businessId”: 43111, "businessIdcode": 43111null, "createdDate": 15350496800251535049680026, "createdUser": "JoeSchmo", "directions": null, "groupItemId "email": 237963,"petzRus@noemail.com", "embedCode": null, "internalDisplayName"“groupescription”: "Cat Grooming", <p>All of our pet related gigs in one group!</p>", "modifiedDategroupId": 15350481004336239, "modifiedUsergroupItems": "JoeSchmo",[{ "objectIdactive": 255109true, "objectTypebusinessId": "SERVICE"43111, }] "groupNamecreatedDate": 1535049680026, "Pet Pampering", "groupTypecreatedUser": "SERVICEJoeSchmo", "internalDisplayNamegroupItemId": "Pet Pampering"237961, “internalName”: null, "itemNameListinternalDisplayName": ["Pooch Primping", "Dog Training", "Cat Grooming"], "logoUrlmodifiedDate": null153504810043, "modifiedDatemodifiedUser": 1535048100252"JoeSchmo", "modifiedUserobjectId": "'JoeSchmo",159330, "privateUrlobjectType": "http://www.timetap.com/appts/Z7kxFw3pL",SERVICE" },{ "screeningQuestionactive": nulltrue, "sortWeightbusinessId": null43111, “timeZoneCode” "createdDate": null } | ||||||||
| Code Block | ||||||||
| ||||||||
{1535049680026, “active”"createdUser": true"JoeSchmo", “allowOnline”: true, "businessIdgroupItemId": 43111237962, “createdDate”: 1530107194592, "createdUserinternalDisplayName": "JoeSchmoDog Training", "directionsmodifiedDate": null153504810043, "email": null, “embedCode”: "<iframe src='https://www.timetap.com/pembed/JODqTXMAUx' frameborder='0' width='840' height='500'> </iframe>", “groupDescription”: "All of our aquatic classes", "groupId": 29573, "groupItems": [{ "active": true"modifiedUser": "JoeSchmo", "objectId": 177850240094, "objectType": "SERVICE" },{ "active": true, "objectIdbusinessId": 16073443111, "objectTypecreatedDate": "SERVICE" 1535049680025, }] "groupName": "Aquatics", "groupTypecreatedUser": "SERVICEJoeSchmo", "internalDisplayNamegroupItemId": "Aquatics"237963, “internalName”: null, "itemNameListinternalDisplayName": ["Surfing for beginners", "Wading"]Cat Grooming", “logoUrl”: null, "modifiedDate": 1531748369398153504810043, "modifiedUser": "JoeSchmo", “privateUrl”"objectId": “http://www.timetap.com/appts/Z7kwFP2pUd”255109, "screeningQuestionobjectType": null,"SERVICE" }] "sortWeightgroupName": null"Pet Pampering", "timeZoneCodegroupType": null } |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{"SERVICE", "internalDisplayName": "active"Pet Pampering", “internalName”: truenull, "allOrNoneSelectLocationsitemNameList": {value:["Pooch Primping", "selectDog Training", label:"Cat "Select Locations"}Grooming"], "logoUrl": null, "businessIdmodifiedDate": 431111535048100252, "groupItemsmodifiedUser": {active: true, objectType: "LOCATION", objectId: 87877}"'JoeSchmo", "privateUrl": "http://www.timetap.com/appts/Z7kxFw3pL", "groupNamescreeningQuestion": "Putty tats"null, "groupTypesortWeight": "LOCATION"null, "timeZoneCode"“timeZoneCode”: null } |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"active"“active”: true,
"allowOnline"“allowOnline”: true,
"businessId": 43111,
"code": null,
"createdDate"“createdDate”: 1530107194592,
"createdUser": "JoeSchmo",
"directions": null,
"email": null,
"embedCode"“embedCode”: "<iframe src='https://www.timetap.com/pembed/Z7kwFP2pUdJODqTXMAUx' frameborder='0' width='840' height='500'></iframe>"'> </iframe>",
“groupDescription”: "All of our aquatic classes",
"groupId": 29573,
"groupItems": [{
"active": true,
"groupDescriptionobjectId": "All177850,
of our aquatic classes", "groupIdobjectType": 29573, "SERVICE"
},{
"groupItemIdsactive": [177850],true,
"groupItemsobjectId": [{groupItemId: 306752, businessId: 43111, objectType160734,
"objectType": "SERVICE",
objectId: 177850,…}],
"groupName": "Aquatics",
"groupType": "SERVICE",
"internalDisplayName": "Aquatics",
"internalName"“internalName”: null,
"itemNameList": ["Surfing for Beginnersbeginners", "Wading"],
"logoUrl"“logoUrl”: null,
"modifiedDate": 15496546741181531748369398,
"modifiedUser": "JoeSchmo",
"privateUrl"“privateUrl”: "https“http://www.timetap.com/appts/Z7kwFP2pUd"Z7kwFP2pUd”,
"screeningQuestion": null,
"sortWeight": null,
"textSearchable": "Aquatics All of our aquatic classes",
"timezonetimeZoneCode": null
} |
| Property name | Type | Required | Writable | Description |
|---|---|---|---|---|
| active | boolean | Yes | Indicates whether or not specified group should return on GET calls. | |
| allowOnline | boolean | Yes | Indicates whether or not specified group shows on the scheduler. | |
| businessId | integer | Yes | Provides unique numerical ID of the business to which specified group belongs. | |
| createdDate | integer | Displays as date specified group was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
| createdUser | string | Displays the username of user who created specified group. | ||
| directions | string | Yes | Displays as directions provided on specified group's profile. | |
| string | Yes | Displays as email provided for specified group. | ||
| embedCode | string | Provides iframe code that can be used to display scheduler for specified group based on address given on the group's profile; back-end component, users cannot alter. | ||
| groupDescription | string | Yes | Displays as description provided on specified group's profile. | |
| groupId | integer | Yes, on PUT calls | Provides unique numerical ID of specified group. | |
| groupItems | array | Yes | Shows all objects in specified group in array format. | |
| groupName | string | Yes | Displays as public name of specified group. | |
| groupType | string | Provides the type of group specified group is. Options are "LOCATION" and "SERVICE". | ||
| internalDisplayName | string | Yes | If groupName is filled out but internalName is empty, internalDisplayName would be the same as the groupName; if internalName is not empty, internalDisplayName would be the same as the internalName. | |
| internalName | string | Yes | Displays as group name that staff see when logged into backoffice of TimeTap | |
| itemNameList | array | Yes | Shows internalDisplayNames for all objects in specified group. | |
| logoUrl | string | Displays as URL of specified group. | ||
modifiedDate | integer | Displays as date specified group was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
| modifiedUser | string | Displays the username of user who last modified specified group. | ||
| privateUrl | string | Displays as URL of specified group's private scheduling page. | ||
| screeningQuestion | object | Yes | Displays any screening questions added to specified group. Only applies to groupType of SERVICE. | |
| sortWeight | integer | Yes | Affects the order in which different groups of a business are displayed to users. | |
| timeZoneCode | object | Displays the timezone code used by specified group. Only applies to groupType of LOCATION. For more info, see Timezones API page. |