# Fivexer Workers API

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

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

The workers API from Fivexer — 21 operation(s) for workers.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| GET | `/portal/photos/{file}` | A worker profile photo (no authentication; the URL is the credential) |
| GET | `/v1/workers/approvals` | People waiting for approval to join, oldest first |
| POST | `/v1/workers/approvals` | Approve or reject people waiting to join, many at once |
| POST | `/v1/workers` | Create or update a worker |
| GET | `/v1/workers` | List worker ids |
| GET | `/v1/workers/{id}` | Worker detail: routing profile, availability, load |
| PATCH | `/v1/workers/{id}` | Update a worker in place (partial) |
| DELETE | `/v1/workers/{id}` | Remove (offboard) a worker |
| POST | `/v1/workers/{id}/availability` | Pause or resume a worker (backlog preserved unless releaseBacklog) |
| GET | `/v1/workers/{id}/queue` | A worker's current task queue |
| GET | `/v1/workers/{id}/metrics` | Worked time, breaks and throughput for one worker |
| GET | `/v1/workers/{id}/task-time` | What one worker spent time on, measured from task transitions |
| GET | `/v1/workers/{id}/time/day` | One worker's day as a timeline |
| GET | `/v1/workers/{id}/time-entries` | The shift and break log for one worker over a window |
| POST | `/v1/workers/{id}/time-entries` | Record a shift that was worked but never logged |
| PATCH | `/v1/workers/{id}/time-entries/{entryId}` | Correct one recorded shift or break, keeping what it said before |
| PATCH | `/v1/workers/{id}/time-entries/{entryId}/metadata` | Add a description or task link to a recorded shift or break |
| PUT | `/v1/workers/{id}/time-entries/{entryId}/roles` | State the roles a recorded shift was worked in |
| POST | `/v1/workers/{id}/role` | Change the role a worker on shift is doing |
| GET | `/v1/workers/{id}/time-corrections` | Changes made to one worker's time records |
| GET | `/v1/workers/{id}/offboarding` | Preview what removing a worker hands back and frees |
| GET | `/v1/workers/links` | List worker ↔ connector user links |
| PUT | `/v1/workers/{id}/links/{connector}` | Link a worker to their user in a connected system |
| DELETE | `/v1/workers/{id}/links/{connector}` | Remove a worker’s link to a connected system |
| DELETE | `/v1/workers/{id}/photo` | Remove a worker’s profile photo |
| GET | `/v1/workers/leave-settlements` | List removed workers whose leave is not yet settled |
| POST | `/v1/workers/{id}/settle-leave` | Settle a removed worker’s leave |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/5xer-com/openapi/5xer-com-workers-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

Workers

---

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