Fivexer

Fivexer Supervisor API

The supervisor API from Fivexer — 19 operation(s) for supervisor.

GitHub OpenAPI

Operations 20

GET /v1/supervisor-auth/entry Where a supervisor can sign in from #
POST /v1/supervisor-auth/accept Redeem a supervisor link for a session #
POST /v1/supervisor-auth/logout End this supervisor session #
GET /v1/supervisor/me The signed-in supervisor and their scope #
GET /v1/supervisor/voice/ice ICE servers for a voice call #
GET /v1/supervisor/overview Queue, crew and parked work in this supervisor’s scope #
POST /v1/supervisor/tasks/{id}/unpark Return a parked task to the queue #
POST /v1/supervisor/tasks/{id}/priority Bump a task’s priority #
POST /v1/supervisor/tasks/{id}/assign Hand a task to a specific worker #
POST /v1/supervisor/workers/{workerId}/availability Pause or resume a worker in this supervisor’s crew #
GET /v1/supervisor/push/config VAPID public key for subscribing to supervisor push #
POST /v1/supervisor/push/subscriptions Register this device for supervisor push #
DELETE /v1/supervisor/push/subscriptions Stop supervisor push to this device #
GET /v1/supervisor/timeoff List the crew’s time-off requests #
POST /v1/supervisor/timeoff/{id}/approve Approve a time-off request #
POST /v1/supervisor/timeoff/{id}/deny Deny a time-off request #
GET /v1/supervisor/roster The crew’s published roster #
GET /v1/supervisor/cover Absences on the crew that need cover #
GET /v1/supervisor/cover/{coverId}/openings/{openingId}/candidates Who can cover, nearest first #
POST /v1/supervisor/cover/{coverId}/openings/{openingId}/offer Offer a shift to several of the crew #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/5xer-com/openapi/5xer-com-supervisor-api-openapi.yml

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-supervisor-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.

GitHub Google LinkedIn

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

OpenAPI Specification

5xer-com-supervisor-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fivexer Platform Supervisor 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:
- name: supervisor
paths:
  /v1/supervisor-auth/entry:
    get:
      summary: Where a supervisor can sign in from
      tags:
      - supervisor
      security: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorAuthEntry
      x-operation-id-source: derived
  /v1/supervisor-auth/accept:
    post:
      summary: Redeem a supervisor link for a session
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - token
              properties:
                token:
                  type: string
                  minLength: 8
                  maxLength: 200
      security: []
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorAuthAccept
      x-operation-id-source: derived
  /v1/supervisor-auth/logout:
    post:
      summary: End this supervisor session
      tags:
      - supervisor
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorAuthLogout
      x-operation-id-source: derived
  /v1/supervisor/me:
    get:
      summary: The signed-in supervisor and their scope
      tags:
      - supervisor
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorMe
      x-operation-id-source: derived
  /v1/supervisor/voice/ice:
    get:
      summary: ICE servers for a voice call
      tags:
      - supervisor
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorVoiceIce
      x-operation-id-source: derived
  /v1/supervisor/overview:
    get:
      summary: Queue, crew and parked work in this supervisor’s scope
      tags:
      - supervisor
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorOverview
      x-operation-id-source: derived
  /v1/supervisor/tasks/{id}/unpark:
    post:
      summary: Return a parked task to the queue
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                resetEscalation:
                  type: boolean
                resetSla:
                  type: boolean
                resetSchedule:
                  type: boolean
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorTasksByIdUnpark
      x-operation-id-source: derived
  /v1/supervisor/tasks/{id}/priority:
    post:
      summary: Bump a task’s priority
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - priority
              properties:
                priority:
                  type: number
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorTasksByIdPriority
      x-operation-id-source: derived
  /v1/supervisor/tasks/{id}/assign:
    post:
      summary: Hand a task to a specific worker
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - workerId
              properties:
                workerId:
                  type: string
                  maxLength: 128
                force:
                  type: boolean
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorTasksByIdAssign
      x-operation-id-source: derived
  /v1/supervisor/workers/{workerId}/availability:
    post:
      summary: Pause or resume a worker in this supervisor’s crew
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - available
              properties:
                available:
                  type: boolean
                releaseBacklog:
                  type: boolean
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: workerId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorWorkersByWorkerIdAvailability
      x-operation-id-source: derived
  /v1/supervisor/push/config:
    get:
      summary: VAPID public key for subscribing to supervisor push
      tags:
      - supervisor
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorPushConfig
      x-operation-id-source: derived
  /v1/supervisor/push/subscriptions:
    post:
      summary: Register this device for supervisor push
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - endpoint
              - keys
              properties:
                endpoint:
                  type: string
                  minLength: 8
                  maxLength: 2048
                keys:
                  type: object
                  additionalProperties: false
                  required:
                  - p256dh
                  - auth
                  properties:
                    p256dh:
                      type: string
                      minLength: 1
                      maxLength: 256
                    auth:
                      type: string
                      minLength: 1
                      maxLength: 256
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorPushSubscriptions
      x-operation-id-source: derived
    delete:
      summary: Stop supervisor push to this device
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - endpoint
              - keys
              properties:
                endpoint:
                  type: string
                  minLength: 8
                  maxLength: 2048
                keys:
                  type: object
                  additionalProperties: false
                  required:
                  - p256dh
                  - auth
                  properties:
                    p256dh:
                      type: string
                      minLength: 1
                      maxLength: 256
                    auth:
                      type: string
                      minLength: 1
                      maxLength: 256
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: deleteV1SupervisorPushSubscriptions
      x-operation-id-source: derived
  /v1/supervisor/timeoff:
    get:
      summary: List the crew’s time-off requests
      tags:
      - supervisor
      parameters:
      - schema:
          type: string
          enum:
          - pending
          - approved
          - denied
          - cancelled
        in: query
        name: status
        required: false
      - schema:
          type: integer
          minimum: 1
          maximum: 500
        in: query
        name: limit
        required: false
      - schema:
          type: string
          maxLength: 256
        in: query
        name: cursor
        required: false
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorTimeoff
      x-operation-id-source: derived
  /v1/supervisor/timeoff/{id}/approve:
    post:
      summary: Approve a time-off request
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                note:
                  type:
                  - string
                  - 'null'
                  maxLength: 512
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorTimeoffByIdApprove
      x-operation-id-source: derived
  /v1/supervisor/timeoff/{id}/deny:
    post:
      summary: Deny a time-off request
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                note:
                  type:
                  - string
                  - 'null'
                  maxLength: 512
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorTimeoffByIdDeny
      x-operation-id-source: derived
  /v1/supervisor/roster:
    get:
      summary: The crew’s published roster
      tags:
      - supervisor
      parameters:
      - schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        in: query
        name: from
        required: false
      - schema:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
        in: query
        name: to
        required: false
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorRoster
      x-operation-id-source: derived
  /v1/supervisor/cover:
    get:
      summary: Absences on the crew that need cover
      tags:
      - supervisor
      security:
      - supervisorToken: []
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorCover
      x-operation-id-source: derived
  /v1/supervisor/cover/{coverId}/openings/{openingId}/candidates:
    get:
      summary: Who can cover, nearest first
      tags:
      - supervisor
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: coverId
        required: true
      - schema:
          type: string
        in: path
        name: openingId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: getV1SupervisorCoverByCoverIdOpeningsByOpeningIdCandidates
      x-operation-id-source: derived
  /v1/supervisor/cover/{coverId}/openings/{openingId}/offer:
    post:
      summary: Offer a shift to several of the crew
      tags:
      - supervisor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - workerIds
              properties:
                workerIds:
                  type: array
                  minItems: 1
                  maxItems: 50
                  items:
                    type: string
                    minLength: 1
                    maxLength: 128
                expiresInMinutes:
                  type: integer
                  minimum: 1
                  maximum: 1440
      security:
      - supervisorToken: []
      parameters:
      - schema:
          type: string
        in: path
        name: coverId
        required: true
      - schema:
          type: string
        in: path
        name: openingId
        required: true
      responses:
        '200':
          description: Default Response
      operationId: postV1SupervisorCoverByCoverIdOpeningsByOpeningIdOffer
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Workspace API key (sk_test_/sk_live_)
    session:
      type: http
      scheme: bearer
      description: Console session token (st_...)
    adminToken:
      type: http
      scheme: bearer
      description: Operator ADMIN_TOKEN
    workerToken:
      type: http
      scheme: bearer
      description: Worker session token (wt_...)
    supervisorToken:
      type: http
      scheme: bearer
      description: Supervisor session token (sv_...), scoped to one workspace and optionally one team