/work_schedules

🚧
This endpoint uses r_account scope. This is a new scope that is not currently supported by access tokens already used for ATS related endpoints. You need to contact support to enable it for your account tokens.

👍
Integrating with Partner tokens through OAuth 2.0 works out of the box

Results

Calling the /work_schedules endpoint will return a collection of the defined work_schedules for the account. An example of the response follows:

[
    {
        "id": "5c6",
        "name": "08:30 - 17:00 | 30' break",
        "status": "active",
        "work_days": [
            {
                "day_of_week": "monday",
                "work_hours": "8.00",
                "break_duration": "00:30",
                "work_intervals": [
                    {
                        "to_time": "17:00",
                        "from_time": "08:30"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "tuesday",
                "work_hours": "8.00",
                "break_duration": "00:30",
                "work_intervals": [
                    {
                        "to_time": "17:00",
                        "from_time": "08:30"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "wednesday",
                "work_hours": "8.00",
                "break_duration": "00:30",
                "work_intervals": [
                    {
                        "to_time": "17:00",
                        "from_time": "08:30"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "thursday",
                "work_hours": "8.00",
                "break_duration": "00:30",
                "work_intervals": [
                    {
                        "to_time": "17:00",
                        "from_time": "08:30"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "friday",
                "work_hours": "8.00",
                "break_duration": "00:30",
                "work_intervals": [
                    {
                        "to_time": "17:00",
                        "from_time": "08:30"
                    }
                ],
                "break_intervals": []
            }
        ],
        "week_starts_on": "monday",
        "work_hours": "40.00"
    },
    {
        "id": "5c7",
        "name": "Mon - Fri | 09.00 - 15.00 & 18.00 - 21.00 | 1h break",
        "status": "active",
        "work_days": [
            {
                "day_of_week": "monday",
                "work_hours": "8.00",
                "break_duration": "01:00",
                "work_intervals": [
                    {
                        "to_time": "15:00",
                        "from_time": "09:00"
                    },
                    {
                        "to_time": "21:00",
                        "from_time": "18:00"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "tuesday",
                "work_hours": "8.00",
                "break_duration": "01:00",
                "work_intervals": [
                    {
                        "to_time": "15:00",
                        "from_time": "09:00"
                    },
                    {
                        "to_time": "21:00",
                        "from_time": "18:00"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "wednesday",
                "work_hours": "8.00",
                "break_duration": "01:00",
                "work_intervals": [
                    {
                        "to_time": "15:00",
                        "from_time": "09:00"
                    },
                    {
                        "to_time": "21:00",
                        "from_time": "18:00"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "thursday",
                "work_hours": "8.00",
                "break_duration": "01:00",
                "work_intervals": [
                    {
                        "to_time": "15:00",
                        "from_time": "09:00"
                    },
                    {
                        "to_time": "21:00",
                        "from_time": "18:00"
                    }
                ],
                "break_intervals": []
            },
            {
                "day_of_week": "friday",
                "work_hours": "8.00",
                "break_duration": "01:00",
                "work_intervals": [
                    {
                        "to_time": "15:00",
                        "from_time": "09:00"
                    },
                    {
                        "to_time": "21:00",
                        "from_time": "18:00"
                    }
                ],
                "break_intervals": []
            }
        ],
        "week_starts_on": "monday",
        "work_hours": "40.00"
    }
]

Each work_schedule item will have the following keys:

key	type	description
id	`string`	The work schedule identifier. Note that this `id` should be used when creating or updating an employee using the `POST` and `PATCH` endpoints respectively.
name	`string`	The name of the work schedule
status	`string`	The status of the specific work schedule. Available values are `active` and `archived`

The other configuration objects are not relevant with the employee creation and only affect the time off calculations