# Fivexer Roster API

**Canonical:** https://apis.io/apis/5xer-com/5xer-com-roster-api/  
**Provider:** Fivexer — https://apis.io/providers/5xer-com/  
**Base URL:** https://5xer.com  
**Documentation:** https://5xer.com/docs/api/

Fivexer Roster API is one of 29 APIs that [Fivexer](https://apis.io/providers/5xer-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Roster. The published artifact set on APIs.io includes an OpenAPI specification.

The roster API from Fivexer — 90 operation(s) for roster.

## Operations (60 of 112)

| Method | Path | Summary |
|---|---|---|
| GET | `/public/rota/{token}` | A published rota, as a public page shows it (no authentication) |
| GET | `/public/rota/{token}/calendar.ics` | One person's shifts from a public rota page, as a calendar feed (no… |
| GET | `/v1/roster/public-pages` | List public rota pages |
| POST | `/v1/roster/public-pages` | Create a public rota page for a site, a team or both |
| PATCH | `/v1/roster/public-pages/{id}` | Turn a public rota page on or off, or change who can read it |
| DELETE | `/v1/roster/public-pages/{id}` | Delete a public rota page |
| GET | `/v1/roster/cycles` | List planning cycles |
| GET | `/v1/roster/cycles/runs` | List planning cycle runs |
| GET | `/v1/roster/cycles/runs/{id}` | Read a planning cycle run and its log |
| POST | `/v1/roster/cycles/runs/{id}/remind` | Remind a planning run's crew to send their wishes |
| POST | `/v1/roster/cycles/runs/{id}/hold` | Hold a planned rota so it does not go out on its own, or release it |
| POST | `/v1/roster/cycles/runs/{id}/waive-drafts` | Waive a planned run's current draft busy periods so it can publish without them |
| POST | `/v1/roster/cycles/runs/{id}/replan` | Send a planned run back to be solved again, at once |
| POST | `/v1/roster/cycles/runs/{id}/approve` | Approve a planned rota: publish it now and offer its empty shifts |
| POST | `/v1/roster/cycles/preview` | Preview the dates a planning cycle would give |
| GET | `/v1/roster/cycles/{scope}` | Read a planning cycle |
| PUT | `/v1/roster/cycles/{scope}` | Save a planning cycle |
| GET | `/v1/roster/settings` | Read rostering settings |
| PUT | `/v1/roster/settings` | Update rostering settings |
| GET | `/v1/roster/holiday-locations` | Countries and regions the holiday calendar covers |
| GET | `/v1/roster/holidays` | Public holidays in a window, from the workspace’s calendar |
| GET | `/v1/roster/pay` | Read the workspace pay setup |
| PUT | `/v1/roster/pay` | Update the workspace pay setup |
| GET | `/v1/roster/terms/{workerId}/tax-profile` | One worker's statutory tax profile |
| GET | `/v1/roster/tax-jurisdictions` | The countries whose payroll rules this deployment ships |
| GET | `/v1/roster/terms` | Every worker's terms — contract, rate, overtime consent |
| GET | `/v1/roster/terms/{workerId}/preferences` | Read one worker's schedule wishes |
| PUT | `/v1/roster/terms/{workerId}/preferences` | Replace one worker's schedule wishes |
| PUT | `/v1/roster/terms/{workerId}` | Replace one worker's terms |
| GET | `/v1/roster/planned-hours` | Planned hours by worker and pay bracket, from the rota |
| GET | `/v1/roster/starting-points` | Rule packs, shift patterns and site shapes to start from |
| POST | `/v1/roster/patterns/{id}/apply` | Create a shift pattern’s templates |
| GET | `/v1/roster/templates` | List shift templates |
| POST | `/v1/roster/templates` | Create a shift template |
| PATCH | `/v1/roster/templates/{id}` | Update a shift template |
| DELETE | `/v1/roster/templates/{id}` | Delete a shift template |
| POST | `/v1/roster/site-shapes/{id}/apply` | Seed a coverage grid from a site shape |
| GET | `/v1/roster/coverage` | Stations, bands and the shifts that fill them |
| DELETE | `/v1/roster/coverage` | Empty the coverage grid |
| GET | `/v1/roster/sites` | List sites and their travel times |
| POST | `/v1/roster/sites` | Create a site |
| PATCH | `/v1/roster/sites/{id}` | Update a site or its travel times |
| DELETE | `/v1/roster/sites/{id}` | Delete a site |
| GET | `/v1/roster/geocode` | Find a place by address |
| POST | `/v1/roster/sites/travel/estimate` | Estimate travel times between sites |
| GET | `/v1/roster/stations` | List coverage posts |
| POST | `/v1/roster/stations` | Create a coverage post |
| PATCH | `/v1/roster/stations/{id}` | Update a coverage post |
| DELETE | `/v1/roster/stations/{id}` | Delete a coverage post and its shifts |
| GET | `/v1/roster/bands` | List shift bands |
| POST | `/v1/roster/bands` | Create a shift band |
| PATCH | `/v1/roster/bands/{id}` | Update a shift band and the shifts in it |
| DELETE | `/v1/roster/bands/{id}` | Delete a shift band and its shifts |
| PUT | `/v1/roster/coverage/{stationId}/{bandId}` | Replace the shifts in one coverage cell |
| GET | `/v1/rosters` | List rosters overlapping a window |
| POST | `/v1/rosters` | Create a draft roster |
| GET | `/v1/rosters/{id}` | Get a roster with its grid and assignments |
| PATCH | `/v1/rosters/{id}` | Update a roster’s name, team, staffing strategy or time zone |
| DELETE | `/v1/rosters/{id}` | Delete a roster |
| PUT | `/v1/rosters/{id}/demand` | Set what a draft roster needs on particular dates |

…and 52 more operations. They are listed in full on the page.

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/5xer-com/openapi/5xer-com-roster-api-openapi.yml

## Other Fivexer APIs (12)

- [Fivexer Admin API](https://apis.io/apis/5xer-com/5xer-com-admin-api/)
- [Fivexer Agents API](https://apis.io/apis/5xer-com/5xer-com-agents-api/)
- [Fivexer Auth API](https://apis.io/apis/5xer-com/5xer-com-auth-api/)
- [Fivexer Calendar API](https://apis.io/apis/5xer-com/5xer-com-calendar-api/)
- [Fivexer Capacity API](https://apis.io/apis/5xer-com/5xer-com-capacity-api/)
- [Fivexer Console API](https://apis.io/apis/5xer-com/5xer-com-console-api/)
- [Fivexer Decisions API](https://apis.io/apis/5xer-com/5xer-com-decisions-api/)
- [Fivexer Intake API](https://apis.io/apis/5xer-com/5xer-com-intake-api/)
- [Fivexer Knowledge API](https://apis.io/apis/5xer-com/5xer-com-knowledge-api/)
- [Fivexer Learning API](https://apis.io/apis/5xer-com/5xer-com-learning-api/)
- [Fivexer Leave API](https://apis.io/apis/5xer-com/5xer-com-leave-api/)
- [Fivexer Notifications API](https://apis.io/apis/5xer-com/5xer-com-notifications-api/)

## Tags

Roster

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/5xer-com/5xer-com-roster-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/5xer-com/.