# Fivexer Capacity API

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

Fivexer Capacity 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 Capacity. The published artifact set on APIs.io includes an OpenAPI specification.

The capacity API from Fivexer — 40 operation(s) for capacity.

## Operations (45)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/capacity/alerts` | List capacity alerts, soonest act-by first |
| POST | `/v1/capacity/alerts/{id}/ack` | Acknowledge a capacity alert |
| POST | `/v1/capacity/alerts/{id}/action` | Record what was done about a capacity alert |
| POST | `/v1/capacity/alerts/{id}/standby` | Ask people to stand by for an alert’s shift — not a shift yet |
| GET | `/v1/capacity/radar` | The next 72 hours of published shifts, judged |
| GET | `/v1/capacity/today` | Where each routing lane is heading over the next 8 hours |
| GET | `/v1/capacity/precision` | How often each alert tier was followed by a short shift, and shortages avoided |
| GET | `/v1/capacity/settings` | Capacity radar settings |
| PUT | `/v1/capacity/settings` | Change capacity radar settings |
| GET | `/v1/capacity/events` | List capacity events |
| POST | `/v1/capacity/events` | Record a known busy or closed period |
| PATCH | `/v1/capacity/events/{id}` | Change a capacity event (an applied one returns to draft) |
| DELETE | `/v1/capacity/events/{id}` | Withdraw and archive a capacity event |
| GET | `/v1/capacity/events/{id}/preview` | What accepting a capacity event would change |
| POST | `/v1/capacity/events/{id}/accept` | Apply a capacity event to the shift templates it touches |
| POST | `/v1/capacity/events/{id}/withdraw` | Take a capacity event off its templates |
| POST | `/v1/capacity/events/{id}/occurrences/{date}/skip` | Skip one day of a busy period (an applied one stays applied) |
| POST | `/v1/capacity/events/{id}/occurrences/{date}/unskip` | Bring back a skipped day of a busy period |
| POST | `/v1/capacity/events/{id}/occurrences/{date}/move` | Move one day of a busy period to another day, as a period of its own |
| POST | `/v1/capacity/events/{id}/occurrences/{date}/move-back` | Put a moved day of a busy period back on the day it came from |
| POST | `/v1/capacity/events/{id}/series/move` | Move every day of a busy period by a few days (every Friday to Saturday) |
| GET | `/v1/capacity/forecast` | The workspace forecast: series, accuracy and staffing groups |
| GET | `/v1/capacity/forecast/series/{series}` | One series, hour by hour (nowcast re-applied) and week by week |
| GET | `/v1/capacity/forecast/staffing/{group}` | People a staffing group needs each hour, against what is rostered |
| GET | `/v1/capacity/forecast/weeks` | Week by week for six months: volume, the people-hours it takes, and what is… |
| GET | `/v1/capacity/spikes` | Days the forecast could not explain |
| POST | `/v1/capacity/spikes/{id}/name` | Name a spike: it becomes a past event the forecast learns from |
| POST | `/v1/capacity/spikes/{id}/dismiss` | Nothing to name: hide a spike |
| GET | `/v1/capacity/coming-up` | Busy or quiet days the platform noticed coming |
| POST | `/v1/capacity/coming-up/accept` | Record a suggestion as a draft event (never applied without its own accept) |
| POST | `/v1/capacity/coming-up/dismiss` | Stop suggesting this |
| POST | `/v1/capacity/events/suggest` | Fill in an event from its name and dates: kind, size, and which work moves |
| GET | `/v1/capacity/tag-shifts` | Which shifts work each tag, and suggestions |
| PUT | `/v1/capacity/tag-shifts/{tag}` | Confirm which shifts work a tag (an empty list unmaps it) |
| GET | `/v1/capacity/forecast/proposals` | Raises the forecast proposes, or (status=accepted) the ones still to come that… |
| POST | `/v1/capacity/forecast/proposals/{id}/accept` | Accept a proposal: one labelled override on its shift |
| POST | `/v1/capacity/forecast/proposals/{id}/withdraw` | Take an accepted raise back: its override comes off the shift and the rotas |
| POST | `/v1/capacity/forecast/proposals/{id}/dismiss` | Not this time |
| POST | `/v1/capacity/import` | Import volumes from a CSV: date, hour?, series, value, unit |
| GET | `/v1/capacity/import/series` | Imported series and their unit |
| GET | `/v1/capacity/import/sources` | Files fetched on a schedule |
| POST | `/v1/capacity/import/sources` | Fetch a file on a schedule (its link and header are stored sealed) |
| PATCH | `/v1/capacity/import/sources/{id}` | Change a scheduled file |
| DELETE | `/v1/capacity/import/sources/{id}` | Stop fetching a file |
| POST | `/v1/capacity/import/sources/{id}/run` | Fetch a scheduled file now |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/5xer-com/openapi/5xer-com-capacity-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 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/)
- [Fivexer Portal API](https://apis.io/apis/5xer-com/5xer-com-portal-api/)

## Tags

Capacity

---

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