Staff/Professional
- Andrew Forster
Â
This Staff API is used to access staff on the business' account based on provided filters. To manage Staff use this API documented here: Staff .
These are the endpoints that are available under the /scheduling/staff path, which lists all the different staff members you have added to your business using TimeTap.
Endpoint | Description |
---|
Endpoint | Description |
---|---|
POST /scheduling/staff | Returns list of staff objects based on provided filters in the post body. |
Data points passed in the request URL or post body portion of the API call that are used to filter the data being requested.Â
Parameter | Type | Endpoints to be used with | Required | Description |
---|
Parameter | Type | Endpoints to be used with | Required | Description |
---|---|---|---|---|
staffIdList | integer array | POST /scheduling/staff | No | List of Staff IDs to limit the returned objects. |
reasonIdList | integer array | POST /scheduling/staff | No | List of Reason IDs to limit the returned Staff Objects to only Staff that offer the provided reasons. |
locationIdList | integer array | POST /scheduling/staff | No | List of Reason IDs to limit the returned Staff Objects to only Staff that offer services at the provided location. |
locationGroupIdList | integer array | POST /scheduling/staff | No | List of Location Group IDs to limit the returned Staff Objects to only Staff that offer services at the locations in the groups. |
reasonGroupIdList | integer array | POST /scheduling/staff | No | List of Reason Group IDs to limit the returned Staff Objects to only Staff that offer the provided reasons in the groups. |
classScheduleIdList | integer array | POST /scheduling/staff | No | List of Classs Schedule IDs to limit the returned Staff Objects to only Staff that offer the provided classes. |
locationSuperGroupIdList | integer array | POST /scheduling/staff | No | List of Location Super Group IDs to limit the returned Staff Objects to only Staff that offer services at the provided location groups under the super groups. |
reasonSuperGroupIdList | integer array | POST /scheduling/staff | No | List of Reason Super Group IDs to limit the returned Staff Objects to only Staff that offer the provided reasons under the reason groups under the super groups. |
Staff API Responses
[{
"email": noreply@email.com",
"emailInstructions": null,
"emailInstructions2": null,
"fullName": "Mr. Biscuits",
"imageUrl": null,
"mobilePhone": null,
"professionalId": 80891,
"staffProfile": null,
"syncStaffIdList": null,
"timeZone": "America/Denver",
"virtualRoomId": null,
"virtualRoomUrl": null,
"zoomLink": null
}]