Fivexer Worker Portal API

The worker-portal API from Fivexer — 78 operation(s) for worker-portal.

Operations 91

GET /v1/portal/calendar My Google Calendar connection #
PATCH /v1/portal/calendar Choose how my busy time binds the roster #
DELETE /v1/portal/calendar Disconnect my Google Calendar #
POST /v1/portal/calendar/start Connect my Google Calendar #
POST /v1/portal/calendar/complete Finish connecting my Google Calendar #
POST /v1/portal/calendar/sync Sync my Google Calendar now #
GET /v1/portal/workers/{id}/queue A worker's current task queue #
POST /v1/portal/me/tasks Create a minimal task owned by the authenticated worker; accepted at once only… #
GET /v1/portal/tasks/{id} Task detail, scoped to the authenticated worker #
POST /v1/portal/tasks/{id}/accept Worker accepts a pending task #
POST /v1/portal/tasks/{id}/reject Worker rejects a task (requeued for others); their own accepted to-do returns… #
POST /v1/portal/tasks/{id}/complete Worker completes a task #
GET /v1/portal/tasks/{id}/comments A task's comment thread, oldest first #
POST /v1/portal/tasks/{id}/comments Comment on a task as the authenticated worker #
POST /v1/portal/tasks/{id}/attachments Start an attachment upload on an own task (presigned PUT) #
GET /v1/portal/tasks/{id}/attachments An own task's attachments #
POST /v1/portal/tasks/{id}/attachments/{attachmentId}/confirm Confirm an upload on an own task #
GET /v1/portal/tasks/{id}/attachments/{attachmentId}/download Short-lived presigned download URL for an own task attachment #
POST /v1/portal/tasks/{id}/run Join the run a held task belongs to, or open one named after the task #
GET /v1/portal/me The signed-in worker: identity, shift state, current break #
PATCH /v1/portal/me Set the signed-in worker’s language and mail preference #
PUT /v1/portal/me/photo Set my profile photo #
DELETE /v1/portal/me/photo Remove my profile photo #
GET /v1/portal/voice/ice ICE servers for a voice call #
GET /v1/portal/skills The workspace skill catalog, for a worker choosing their own #
PUT /v1/portal/me/skills Set your own skills — replaces the whole set #
POST /v1/portal/me/availability Go on or off shift — the worker’s own availability switch #
GET /v1/portal/me/connections AI apps connected to my account (Claude, ChatGPT…) #
DELETE /v1/portal/me/connections/{id} Disconnect one of my AI apps: its access ends at once #
GET /v1/portal/me/assistants My AI assistants and whether they are connected #
GET /v1/portal/me/timer The timer this worker has running, if any #
POST /v1/portal/me/timer/start Start the worker’s own timer — optionally against a task they hold #
POST /v1/portal/me/timer/stop Stop the running timer — the entry is saved whether or not it has a name #
PATCH /v1/portal/me/timer/entries/{entryId} Name a saved entry, or attach it to a task, after the fact #
GET /v1/portal/me/time/log What the worker spent a window on, per task and otherwise #
GET /v1/portal/me/time/day Your day as a timeline: shifts, work, breaks, gaps, changes #
GET /v1/portal/breaks/coverage Advisory staffing warnings for taking a break now #
POST /v1/portal/breaks/start Start a break — pauses routing to this worker #
POST /v1/portal/breaks/end End the current break — resumes routing to this worker #
GET /v1/portal/breaks/today The worker's own breaks for today #
GET /v1/portal/team/presence Team presence: who is working vs on break (defaults to the caller’s own crews) #
GET /v1/portal/metrics/today The worker's own metrics for today, or since a given instant #
GET /v1/portal/me/roles The roles this worker can clock in as, and the one they are in now #
POST /v1/portal/me/role Change the role you are working, without leaving your shift #
GET /v1/portal/me/time-entries The worker's own shift and break log (last 7 days) #
POST /v1/portal/me/time-entries Record a shift the worker worked but never clocked #
PATCH /v1/portal/me/time-entries/{entryId} Correct the worker's own shift, or add a description or task link to it #
GET /v1/portal/metrics The worker's own metrics over a rolling window #
POST /v1/portal/workers/me/location Update this worker location for geo routing #
POST /v1/portal/devices Register an Expo push token for this worker #
DELETE /v1/portal/devices Unregister an Expo push token for this worker #
GET /v1/portal/push/config VAPID public key for subscribing the portal to Web Push #
POST /v1/portal/push/subscriptions Register a Web Push subscription for this worker #
DELETE /v1/portal/push/subscriptions Unregister a Web Push subscription for this worker #
POST /v1/portal/me/pin Change the authenticated worker's own PIN #
GET /v1/portal/timeoff List the authenticated worker's time-off requests #
POST /v1/portal/timeoff Ask for time off #
POST /v1/portal/me/time-entries/attest Confirm or dispute your recorded hours for a period #
GET /v1/portal/me/time-entries/attest What you have said about a period’s hours #
GET /v1/portal/leave Leave types and this worker’s balances #
POST /v1/portal/leave/notices/{id}/opened I opened my year-end leave notice #
POST /v1/portal/leave/carry-requests Ask to carry leave over into next year #
GET /v1/portal/leave/quote What a range of leave would cost this worker #
DELETE /v1/portal/timeoff/{id} Withdraw a pending time-off request #
POST /v1/portal/timeoff/{id}/cancel-request Ask for approved time off to be cancelled #
GET /v1/portal/preferences My schedule wishes #
PUT /v1/portal/preferences Replace my schedule wishes #
POST /v1/portal/preferences/confirm Confirm my standing wishes for the periods being planned #
GET /v1/portal/preferences/outcome How my schedule wishes went #
GET /v1/portal/roster/planning Roster periods currently open for planning #
GET /v1/portal/me/bookings The authenticated worker's booked appointments #
POST /v1/portal/me/bookings/{taskId}/hand-back Hand back an appointment booked onto me, with a reason #
GET /v1/portal/roster The authenticated worker's published shifts #
POST /v1/portal/roster/cover Report that you cannot work a shift you are on #
GET /v1/portal/roster/cover/returns Your sick calls, and when you are back #
POST /v1/portal/roster/cover/{id}/return Say which day you are back #
POST /v1/portal/roster/cover/{id}/back Say you are back early #
GET /v1/portal/roster/cover/offers Cover offers waiting on you #
GET /v1/portal/reserves Standby asks waiting on your answer #
PATCH /v1/portal/reserves/{id} Answer a standby ask #
POST /v1/portal/roster/cover/offers/{id}/accept Take a cover shift #
POST /v1/portal/roster/cover/offers/{id}/decline Turn down a cover shift #
GET /v1/portal/roster/open-shifts Shifts posted to the team that you could take #
POST /v1/portal/roster/open-shifts/{openingId}/claim Take a shift posted to the team #
GET /v1/portal/roster/swaps Shift swaps you proposed or were asked about #
POST /v1/portal/roster/swaps Offer one of your shifts to a colleague #
POST /v1/portal/roster/swaps/{id}/accept Accept a shift swap #
POST /v1/portal/roster/swaps/{id}/decline Decline a shift swap #
POST /v1/portal/roster/swaps/{id}/withdraw Take back a swap you proposed #
GET /v1/portal/roster/shifts/{shiftInstanceId}/takers Colleagues who could take one of your shifts #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/5xer-com:5xer-com-worker-portal-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

5xer-com-worker-portal-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fivexer Platform Worker Portal API
  description: 'Routing-as-a-service: create workers and tasks, the platform matches continuously. `/v1` authenticates with a workspace API key (`Authorization: Bearer sk_...`); `/console` with a session token from `/auth`; `/admin` with the operator token.'
  version: 0.1.0
servers:
- url: https://5xer.com
  description: This deployment
tags:


# --- truncated at 32 KB (57 KB total) ---
# Full source: https://artifacts.apis.io/5xer-com/openapi/5xer-com-worker-portal-api-openapi.yml