Groups
- Joel Morgan Kearney (Unlicensed)
- Joel Kearney
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 the listType is set to LOCATION, this endpoint will send back all groups on an account where groupType = LOCATION, and if the 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 the 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 the 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. |
The objects below represent the minimum viable objects to pass that are needed to create or update a groups object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
| Property name | Type | Required | Writable | Description |
|---|---|---|---|---|
| active | boolean | Yes | Indicates whether or not the specified group should return on GET calls. | |
| allowOnline | boolean | Yes | Indicates whether or not the specified group shows on the scheduler. | |
| businessId | integer | Yes | Provides unique numerical ID of the business to which the specified group belongs. | |
| code | string | Displays as the code for the specified group. | ||
| createdDate | integer | Displays as date the 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 the specified group. | ||
| directions | string | Yes | Displays as directions provided on the specified group's profile. | |
| string | Yes | Displays as email provided for the specified group. | ||
| emailInstructions | string | Displays as the email instructions for the specified group. | ||
| embedCode | string | Provides iframe code that can be used to display scheduler for the 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 the specified group's profile. | |
| groupId | integer | Yes, on PUT calls | Provides unique numerical ID of the specified group. | |
| groupItemIds | array | Provides the IDs (either locationIds or reasonIds) that make up the specified group. | ||
| groupItems | array | Yes | Shows all objects in the specified group in array format. | |
| groupName | string | Yes | Displays as public name of the specified group. | |
| groupType | string | Provides the type of group the 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 the group name that staff see when logged into backoffice of TimeTap | |
| itemNameList | array | Yes | Shows internalDisplayNames for all objects in the specified group. | |
| logoUrl | string | Displays as URL of the specified group. | ||
modifiedDate | integer | Displays as date the 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 the specified group. | ||
| privateUrl | string | Displays as URL of the specified group's private scheduling page. | ||
| salesforceId | integer | Provides unique numeric ID associated with the specified group. | ||
| salesforceValue | string | Provides the Salesforce value associated with the specified group. | ||
| screeningQuestion | object | Yes | Displays any screening questions added to the 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. | |
| textSearchable | string | Provides a string of text that you can search for that will return the specified group. | ||
| timeZoneCode | object | Displays the timezone code used by the specified group. Only applies to groupType of LOCATION. For more info, see Timezones API page. |