Location

This Location API is used to access Locations on the business' account based on provided filters. To manage Locations use this administrative API documented here: Location .

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

Endpoint	Description

Endpoint	Description
POST /scheduling/locations	Returns list of location 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/locations	No	List of Staff IDs to limit the returned objects.
reasonIdList	integer array	POST /scheduling/locations	No	List of Reason IDs to limit the returned Staff Objects to only Staff that offer the provided reasons.
locationIdList	integer array	POST /scheduling/locations	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/locations	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/locations	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/locations	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/locations	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/locations	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.

[
    {
        "locationId": 40873,
        "locationName": "Secondary Calendar",
        "description": "",
        "directions": null,
        "logoUrl": null,
        "locationType": "VIRTUAL",
        "allowTZChange": null,
        "latitude": null,
        "longitude": null,
        "officePhone": null,
        "timezone": null,
        "virtualRoomUrl": null
    },
    {
        "locationId": 43001,
        "locationName": "Test new location",
        "description": "",
        "directions": null,
        "logoUrl": null,
        "locationType": "VARIABLE",
        "allowTZChange": null,
        "latitude": null,
        "longitude": null,
        "officePhone": null,
        "timezone": null,
        "virtualRoomUrl": null
    }
]

TimeTap API

Location

Related content