Retrieve the schedules of employees of a center

get https://api.zenoti.com/v1/centers/{center_id}/employee_schedules?start_date={start_date}&end_date={end_date}&schedule_status={schedule_status}&employee_id={employee_id}&job_id={job_id}&consider_schedule_time={consider_schedule_time}

This API helps you to retrieve the schedules of employees of the specified center.
You must provide the unique identifier of the center as center_id. You must also specify the appropriate start_date and end_date values for which you want to view the schedules of employees.

Note: To run this request, you must enable the Schedule role permission. This allows the user to access the employee's schedule. Navigate to the organization-level, Security Roles > employee role > Permissions > Employee Manager > Other Settings > Schedule.

Response Details

Name	Type	Description
employee_schedules	object	Object that contains details about various elements of employees' schedules. For more information, refer to the employee_schedules table below.

employee_schedules

Name	Type	Description
employee_id	guid	Unique 32-character ID of an employee of the center.
employee_name	string	Name of the employee.
schedules	object	Object that contains schedule details of the specific employee. For more information, refer to the schedules table below.

schedules Object

Name	Type	Description
date	datetime	Date of the beginning of the employee's schedule.
shifts	object	Object that contains shift details of the employee. For more information, refer to the shifts table below.

shifts Object

Name	Type	Description
schedule_id	guid	Unique 32-character ID of the schedule of the employee.
start_time	datetime	Start time of the shift of the employee.
end_time	datetime	End time of the shift of the employee.
status	int	Indicates the status of the shift of the employee.
room_id	guid	Unique 32-character ID of the room where the employee was scheduled to work.

error

Name	Type	Description
StatusCode	int	Status code that represents the type of error.
Message	string	Message that describes the error.
InternalMessage	string	Internal message that describes the error in more detail.

error Object

Error Message	Error Code	Description
InvalidInput	502	If the specified `center_id` is not valid.
InvalidInput	502	If the employee does not exist in the organization. The login credentials might not be of an employee.
InvalidInput	502	If the specified date range is not valid. The date range must be between 0 to 30 days.
InvalidInput	502	If the specified start_date or end_date is not valid.
UserNotAuthorized	438	If the Zenoti user does not have the appropriate authorization to retrieve the schedules of employees of a center.

Path Params

center_id

string

required

Mandatory Unique 32-character identifier of the center.

Query Params

start_date

date

required

Mandatory Start date from which the schedules of employees of the specified center will be displayed.

end_date

date

required

Mandatory End date until which the schedules of employees of the specified center will be displayed.

schedule_status

int32

Optional The schedule status of the employee: All = -2, NotScheduled = -1, Working = 0, and the specific code for the respective custom leave.

employee_id

string

Optional Unique 32-character identifier of the employee of the specified center.

job_id

string

Optional Unique 32-character identifier of the employee's assigned job details.

consider_schedule_time

boolean

Optional If true, the API considers the time stamp for the specified date range to filter the response data. If false, the API considers only the date values to filter the employee schedules.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.zenoti.com/v1/centers/center_id/employee_schedules?start_date=start_date&end_date=end_date&schedule_status=schedule_status&employee_id=employee_id&job_id=job_id&consider_schedule_time=consider_schedule_time' \
3
     --header 'Authorization: apikey <your api key>' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Response Details

employee_schedules

schedules Object

shifts Object

error

error Object

200200

400400