# Fivexer Console API

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

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

The console API from Fivexer — 54 operation(s) for console.

## Operations (60 of 77)

| Method | Path | Summary |
|---|---|---|
| GET | `/console/workspaces/{workspaceId}/audit-events` | Access log for this workspace |
| GET | `/console/me` | Current user + memberships |
| PATCH | `/console/me` | Update the signed-in user’s preferences |
| POST | `/console/verification/resend` | Re-send the verification email |
| GET | `/console/workspaces` | Workspaces across all memberships |
| POST | `/console/workspaces` | Create a production workspace (verified email required) |
| POST | `/console/workspaces/{workspaceId}/sandbox/reset` | Load, reload or wipe the sandbox demo data |
| GET | `/console/workspaces/{workspaceId}/sandbox/synthetic` | Read the sandbox synthetic-data settings |
| PUT | `/console/workspaces/{workspaceId}/sandbox/synthetic` | Configure sandbox synthetic-data generation |
| GET | `/console/workspaces/{workspaceId}/onboarding` | Console first-run state + activation stamp |
| PATCH | `/console/workspaces/{workspaceId}/onboarding` | Resolve console first-run state |
| POST | `/console/workspaces/{workspaceId}/onboarding/steps` | Record a first-run screen as reached |
| GET | `/console/workspaces/{workspaceId}/migration-preview` | Preview what would be copied to a new production workspace |
| POST | `/console/workspaces/{workspaceId}/migrate` | Migrate a sandbox to a new production workspace |
| POST | `/console/workspaces/{workspaceId}/api-keys` | Issue an API key (live env requires verified email) |
| GET | `/console/workspaces/{workspaceId}/api-keys` | Key metadata (never secrets) |
| GET | `/console/workspaces/{workspaceId}/usage` | Monthly matched-task usage, newest first (current month is live) |
| GET | `/console/workspaces/{workspaceId}/connections` | MCP apps connected to this workspace over OAuth |
| DELETE | `/console/workspaces/{workspaceId}/connections/{grantId}` | Disconnect an MCP app — every token it holds stops working |
| DELETE | `/console/workspaces/{workspaceId}` | Delete a workspace and all its data (owner role) — irreversible |
| PATCH | `/console/workspaces/{workspaceId}` | Rename a workspace (owner role) |
| DELETE | `/console/api-keys/{id}` | Revoke an API key (owner role) |
| PUT | `/console/workspaces/{workspaceId}/webhook` | Set (or replace) the workspace webhook endpoint |
| DELETE | `/console/workspaces/{workspaceId}/webhook` | Remove the workspace webhook endpoint |
| GET | `/console/workspaces/{workspaceId}/navigation` | Which sidebar rows this workspace shows |
| PUT | `/console/workspaces/{workspaceId}/navigation` | Set the sidebar preset and per-item overrides |
| GET | `/console/workspaces/{workspaceId}/matching` | Current balancer policy (fairness mode + optional window cap) |
| PUT | `/console/workspaces/{workspaceId}/matching` | Set the balancer policy — takes effect on the next match pass |
| GET | `/console/workspaces/{workspaceId}/decisions-config` | Confidence thresholds for machine suggestions |
| PUT | `/console/workspaces/{workspaceId}/decisions-config` | Set the confidence thresholds |
| GET | `/console/workspaces/{workspaceId}/learning` | Current learning configuration |
| PUT | `/console/workspaces/{workspaceId}/learning` | Set the reinforcement-learning configuration |
| GET | `/console/workspaces/{workspaceId}/voice` | Voice calling configuration (TURN credentials redacted) |
| PUT | `/console/workspaces/{workspaceId}/voice` | Enable or disable supervisor↔worker voice calls |
| GET | `/console/workspaces/{workspaceId}/policy-defaults` | Workspace-level escalation and SLA defaults |
| PUT | `/console/workspaces/{workspaceId}/policy-defaults` | Set default escalation/SLA policies for tasks that declare none |
| POST | `/console/workspaces/{workspaceId}/data-plane/test` | Test a BYO Redis connection without saving (owner role) |
| PUT | `/console/workspaces/{workspaceId}/data-plane` | Point the workspace at a BYO Redis (owner role) |
| DELETE | `/console/workspaces/{workspaceId}/data-plane` | Return the workspace to the managed cell (owner role) |
| GET | `/console/workspaces/{workspaceId}/agent-results` | Whether AI agents’ results are kept: the workspace default and each agent that… |
| PUT | `/console/workspaces/{workspaceId}/agent-results` | Set whether AI agents’ results are kept, unless an agent says otherwise (owner… |
| PUT | `/console/workspaces/{workspaceId}/agent-results/{workerId}` | Set one agent’s result write-back; null follows the workspace default (owner… |
| POST | `/console/workspaces/{workspaceId}/workers/{workerId}/identity` | Create a worker identity and PIN for the portal |
| PATCH | `/console/workspaces/{workspaceId}/workers/{workerId}/identity` | Update a worker identity (PIN, label, status) |
| DELETE | `/console/workspaces/{workspaceId}/workers/{workerId}/identity` | Delete a worker identity and all its sessions |
| GET | `/console/workspaces/{workspaceId}/worker-identities` | List worker identities for the portal |
| GET | `/console/workspaces/{workspaceId}/roster/site-owner-candidates` | List the workspace members who can own a site |
| GET | `/console/workspaces/{workspaceId}/supervisors` | List supervisors and crew leads |
| POST | `/console/workspaces/{workspaceId}/supervisors` | Grant supervisor access, optionally scoped to one crew |
| POST | `/console/workspaces/{workspaceId}/supervisors/self-link` | Mint a supervisor sign-in link for the signed-in console user |
| POST | `/console/workspaces/{workspaceId}/supervisors/{supervisorId}/link` | Mint a single-use sign-in link (invalidates any previous one) |
| DELETE | `/console/workspaces/{workspaceId}/supervisors/{supervisorId}` | Revoke supervisor access (kills live sessions and push) |
| POST | `/console/workspaces/{workspaceId}/worker-identities/invite` | Invite a worker by email with a set-your-own-PIN magic link |
| POST | `/console/workspaces/{workspaceId}/worker-identities/{workerId}/invite/resend` | Mint a fresh invite link for a pending identity (invalidates old links) |
| POST | `/console/workspaces/{workspaceId}/join-links` | Create a QR join link for worker self-registration |
| GET | `/console/workspaces/{workspaceId}/join-links` | List QR join links (tokens are never returned after creation) |
| DELETE | `/console/workspaces/{workspaceId}/join-links/{id}` | Revoke a QR join link immediately |
| POST | `/console/workspaces/{workspaceId}/portal/publish` | Publish a new immutable portal version (owner role) |
| POST | `/console/workspaces/{workspaceId}/portal/versions/{version}/publish` | Roll back: make a retained portal version current (owner role) |
| GET | `/console/workspaces/{workspaceId}/portal` | Current portal status: URL, version, config |

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

## Machine-readable artifacts (1)

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

Console

---

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