Get a user's rota, public holidays and custom days
get_user_rotaRetrieve a specific user's rota assignments with start dates, optionally including public holiday and custom day patterns. Use this to view their working schedule.
Instructions
The rota (working pattern) assignments of one user with their start dates, named from the system's rota list, and with include_patterns the public holiday and custom day patterns applied to the user, named from those lists. Up to six API calls.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| partner_user_id | Yes | The user's partner ID | |
| include_patterns | No | Also fetch the user's public holiday and custom day patterns | |
| include_contact_details | No | Include nothing extra (rota and pattern names are the system's own text), and stop redacting email addresses, phone numbers and UK postcodes typed into names and other text |