get
https://api.zenoti.com/v1/centers//employee_schedules?start_date=&end_date=&schedule_status=&employee_id=&job_id=&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. |