Retrieve rota information for a date period.

This endpoint can be used to retrieve an aggregated or detailed view of rotas for a date period.

The default list (basic) returns an aggregated view of rotas, this includes the overall status for each requested day allowing you to determine if a specific day is below the minimum number of shifts required for the requested rotas.

The detailed list returns each rota and its status for each requested day. This includes the shift patterns, timeslots and shifts for all days in the date period. This list will allow you to see the exact status of each rota so that you can determine where you require additional shifts and where you have hit the min/ideal/max number of shifts for a given rota.

This endpoint is limited to 25 rotas per request. Requesting more than 25 rotas will result in a truncated response. It is recommended that you utilise the available filters in the query parameters to narrow down the response to the rotas that you require. If you require additional information on a specific day, please use the rota day endpoint.

Retrieve rota information for a specific day.

This endpoint can be used to retrieve detailed rota information for a specific day, this includes the shift patterns, timeslots and all shifts that are occurring on this date.

This endpoint is limited to 25 rotas per request. Requesting more than 25 rotas will result in a truncated response. It is recommended that you utilise the available filters in the query parameters to narrow down the response to the rotas that you require.

Retrieve rotas by their associated team.

This endpoint returns a list of teams and any active rotas associated with the team. This does not include the status of each rota, this can be retrieved using the rota period or rota day endpoints.

The active_on and active_between query parameters can be used to only include rotas that are active within the given period.

Returns a paginated list of shifts.

Create a new shift.

When a shift is created with a recurrence_pattern, Assemble will automatically create the repeating shifts for the first six months based on the provided pattern. If the repeating shift does not have an end date, Assemble will automatically create shifts each week until the repeating shift is ended.

If you attempt to add a shift to a user that is on-hold, you must provide the ignore_on_hold flag within the request body to override the on-hold validation.

If you attempt to add a shift to a role restricted rota and the user does not have the correct role, you must provide the confirm_role_restriction flag within the request body to override the role restriction validation.

Multiple shifts can be added within one request by providing a shifts array (please see example requests).

Retrieves the details of an existing shift.

Update an existing shift.

edit_mode must be provided as single or recurring.

When edit_mode is single, only the shift specified will be updated. If the shift belongs to a repeating shift series, it will be disassociated from the repeating shift.

When edit_mode is recurring, every future shift in the repeating shift series will be updated with the new information. To prevent updating every shift in the repeating shift series, use the single edit mode.

Cancel an existing shift.

If the shift is within a repeating shift series, you must cancel the repeating shift if you are cancelling all future shifts within the series.

Cancel an existing repeating shift series.

This will also cancel all future shifts that are associated with the repeating shift.

To cancel an individual shift, please see the cancel shift endpoint.

Update an existing rota details and settings.

Using this endpoint, you can update a rotas:

• Name
• Colour
• Restricted role profiles
• Self manage setting
  • This functionality is feature restricted

To update a rotas timeslots, please see the update timeslots endpoint.

If you need to end a rota by updating the rotas end_date, please use the bulk actions endpoint.

Update a rotas timeslots for a single day, date period or all future dates.

This endpoint accepts a from and to date in addition to an weekdays object that contains the timeslots for each weekday within the period. If a weekday is omitted or does not contain any timeslots, the rota will be closed for that day of the week.

If a to date is not provided, all future timeslots will overridden to use the new timeslot pattern provided.

Updating timeslots may automatically cancel or update shifts if they fall outside of the new timeslot pattern.

If you need to mass close rotas for one or more dates, please see the bulk actions endpoint.

Returns a list of all rotas.

This endpoint only includes the rota settings and does not include the status or shift information.

To retrieve status and shift information, please see the rotas and shifts endpoints.

By default, archived rotas are not included in the response.

Create a new rota

Returns a paginated list of all shift patterns

By default, archived patterns are not included in the response.

Create a new shift pattern

Retrieves the details of an existing shift pattern.

Perform a bulk action against a set of rotas.

The following actions can be performed using this endpoint:

• end_date: Update the end date for a set of rotas
• name: Update the rota name for a set of rotas
• close: Close a set of rotas for a day or date period
• archive_rotas: Archive a set of rotas

Replace rotas with another shift pattern.

If end_date is not provided, the shift pattern will override any future pattern/timeslot set up against the rotas.

Replacing patterns may automatically cancel or update shifts if they fall outside of the new shift pattern.