Page Comparison

Expand

title	Staff API Endpoints

These are the endpoints that are available under the /cs/staff path, which lists all the different staff members you have added to your business using TimeTap.

Endpoint	Description
POST /cs/staff	Returns list of staff objects based on provided filters in the post body.

Expand

title	Staff API Parameters

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	Description
staffIdList	integer array	POST /cs/staff	List of Staff IDs to limit the returned objects.
reasonIdList	integer array	POST /cs/staff	List of Reason IDs to limit the returned Staff Objects to only Staff that offer the provided reasons.
locationIdList	integer array	POST /cs/staff	List of Reason IDs to limit the returned Staff Objects to only Staff that offer services at the provided location.
locationGroupIdList	integer array	POST /cs/staff	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 /cs/staff	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 /cs/staff	List of Classs Schedule IDs to limit the returned Staff Objects to only Staff that offer the provided classes.
locationSuperGroupIdList	integer array	POST /cs/staff	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 /cs/staff	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.
locale	String	POST /cs/staff	Displays as general preferred country and language of specified staff person; by default this value is read from their browser settings - for more info, see Locale API page.
clientTimeZone	String	POST /cs/staff	The timezone of the client to search availability.
duration	Integer	POST /cs/staff	The duration of the appointment to search availability.

Staff API Responses

Expand

title	POST /cs/staff

Code Block

[{
    
    "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
}]

Versions Compared

Old Version 2

New Version Current

Key

Staff API Responses