403 Forbidden
Second factor required
- Code
second_factor_required- Status
403Forbidden- Type
https://errors.clavian.io/second-factor-required
What it means
The caller’s role needs a second factor, and this session was signed in without one.
What to do
Ask for the second factor, or for enrolling one if the person has none yet, then repeat the request from the session that has it.
Example
The API answers with status 403 and this body, as application/problem+json. A detail may be added, saying what went wrong this time; it is for people, and changes.
{
"type": "https://errors.clavian.io/second-factor-required",
"title": "Second factor required",
"status": 403,
"code": "second_factor_required",
"requestId": "req_01k5znw4hmfay8vvr14d2pf2db"
}
Endpoints that return it
413 endpoints in the OpenAPI document name it among their answers.
All 413 endpoints
GET /v1/hq/addonsThe add-on cataloguePOST /v1/hq/addonsOffer an add-on, with its pricePATCH /v1/hq/addons/{addonKey}Rename, reprice or stop offering an add-onGET /v1/hq/auditThe platform audit logPOST /v1/hq/audit/exportExport the platform audit log as CSVPUT /v1/hq/boot-server-release-channels/{channel}Make a boot server release current on a channelGET /v1/hq/boot-server-releasesEvery boot server release, and each channel’s current onePOST /v1/hq/boot-server-releasesRegister a signed boot server releaseGET /v1/hq/brandRead the brand configuration, as HQ edits itPUT /v1/hq/brandChange the brand values HQ setsPOST /v1/hq/catalogue/appsAdd an app to the cataloguePOST /v1/hq/catalogue/apps/commonAdd the common apps to the cataloguePATCH /v1/hq/catalogue/apps/{id}Edit an app in the cataloguePOST /v1/hq/catalogue/apps/{id}/iconReserve an icon upload for an app and get a signed upload URLPOST /v1/hq/catalogue/apps/{id}/icon/{uploadId}/completeConfirm an app icon uploadPOST /v1/hq/catalogue/detection/testTest a process list against the catalogue’s detection rulesGET /v1/hq/catalogue/gamesEvery title in the catalogue, newest firstPOST /v1/hq/catalogue/gamesMirror a base game into the cataloguePOST /v1/hq/catalogue/games/manualCreate a catalogue game by handPATCH /v1/hq/catalogue/games/{id}Edit a catalogue gamePOST /v1/hq/catalogue/games/{id}/archiveArchive a catalogue titleGET /v1/hq/catalogue/games/{id}/art-candidatesHero or logo candidates for a catalogue gamePUT /v1/hq/catalogue/games/{id}/art/{kind}Pick the hero or logo of a catalogue gameDELETE /v1/hq/catalogue/games/{id}/art/{kind}Clear the hero or logo of a catalogue gamePUT /v1/hq/catalogue/games/{id}/detectionSet a catalogue title's detection rulesPUT /v1/hq/catalogue/games/{id}/launch-recipesSet a catalogue game's launch recipesPOST /v1/hq/catalogue/games/{id}/refreshRefresh a mirrored game from IGDBGET /v1/hq/catalogue/games/{id}/trailersEvery trailer of a catalogue game, newest firstPOST /v1/hq/catalogue/games/{id}/trailersReserve a trailer for a catalogue game and get a signed upload URLPATCH /v1/hq/catalogue/games/{id}/trailers/{trailerId}Put a trailer in or out of the kiosk loopDELETE /v1/hq/catalogue/games/{id}/trailers/{trailerId}Remove a trailer from a catalogue gamePOST /v1/hq/catalogue/games/{id}/trailers/{trailerId}/completeConfirm a trailer uploadPOST /v1/hq/catalogue/games/{id}/unarchiveBring an archived catalogue title backGET /v1/hq/catalogue/games/{id}/usageHow many venues offer a catalogue titleGET /v1/hq/catalogue/requestsHQ’s inbox of title requestsPOST /v1/hq/catalogue/requests/{requestId}/resolveAnswer a title requestGET /v1/hq/catalogue/searchSearch IGDB for base games to mirrorGET /v1/hq/lead-templatesMessage templatesPOST /v1/hq/lead-templatesAdd a message templatePATCH /v1/hq/lead-templates/{templateId}Edit a message templatePOST /v1/hq/lead-templates/{templateId}/archiveArchive a message templateGET /v1/hq/leadsThe pipeline: leads, filtered and sortedPOST /v1/hq/leadsAdd a leadGET /v1/hq/leads/assigneesHQ members who can own a leadGET /v1/hq/leads/citiesCities that have leads, with countsGET /v1/hq/leads/funnelThe funnel: leads by stage and city, replies by templatePOST /v1/hq/leads/importImport the sales spreadsheet (CSV or XLSX)GET /v1/hq/leads/queueToday: follow-ups due and new leads to contactGET /v1/hq/leads/{leadId}One leadPATCH /v1/hq/leads/{leadId}Edit a leadDELETE /v1/hq/leads/{leadId}Delete a lead and its timelineGET /v1/hq/leads/{leadId}/activitiesA lead’s timeline, newest firstPOST /v1/hq/leads/{leadId}/activitiesLog a note, call, visit or replyPOST /v1/hq/leads/{leadId}/convertConvert a lead into an organisationPOST /v1/hq/leads/{leadId}/outreachRecord a message and get the link to send it fromPOST /v1/hq/leads/{leadId}/stageMove a lead to another stageGET /v1/hq/liveHQ Live: the Platform right nowGET /v1/hq/organizationsEvery organisation on the Platform, newest firstPOST /v1/hq/organizationsInvite a café: create its organisation, and invite its ownerPOST /v1/hq/organizations/pendingRegister an organisation awaiting approvalGET /v1/hq/organizations/{organizationId}Read one organisation’s recordGET /v1/hq/organizations/{organizationId}/addonsOne organisation’s add-onsPOST /v1/hq/organizations/{organizationId}/addonsAttach an add-on to an organisation, for N PCsPATCH /v1/hq/organizations/{organizationId}/addons/{organizationAddonId}Change an organisation’s add-on PC count, or cancel itPOST /v1/hq/organizations/{organizationId}/approvalApprove or decline a pending organisationGET /v1/hq/organizations/{organizationId}/migrationsThe organisation’s migrations, newest firstPOST /v1/hq/organizations/{organizationId}/migrationsStart a migration for one venueGET /v1/hq/organizations/{organizationId}/migrations/{migrationId}One migration: its file, mapping, dry run and progressPOST /v1/hq/organizations/{organizationId}/migrations/{migrationId}/fileUpload the export (CSV or XLSX), replacing any before itPOST /v1/hq/organizations/{organizationId}/migrations/{migrationId}/importImport the next batches of the runPUT /v1/hq/organizations/{organizationId}/migrations/{migrationId}/mappingSet the column mapping, units, station classes, the GST answer and the switch-over day; validatePOST /v1/hq/organizations/{organizationId}/migrations/{migrationId}/moved-emailSend the "account moved" email to the run’s waiting playersGET /v1/hq/organizations/{organizationId}/migrations/{migrationId}/reportThe run’s report, as CSVGET /v1/hq/organizations/{organizationId}/migrations/{migrationId}/rowsThe validated rows, in file order, filtered by status or issuePUT /v1/hq/organizations/{organizationId}/migrations/{migrationId}/ticksHQ’s ticks on the balances above the wallet’s maximumPOST /v1/hq/organizations/{organizationId}/migrations/{migrationId}/undoUndo unclaimed records: the whole run, or oneGET /v1/hq/organizations/{organizationId}/ownerWhether the organisation’s owner has joined, and its newest owner invitationPOST /v1/hq/organizations/{organizationId}/owner-invitationsInvite an owner to an organisation that has noneDELETE /v1/hq/organizations/{organizationId}/owner-invitations/{invitationId}Withdraw a pending owner invitationPOST /v1/hq/organizations/{organizationId}/owner-invitations/{invitationId}/linkThe link of a pending owner invitation, to pass onPOST /v1/hq/organizations/{organizationId}/owner-invitations/{invitationId}/resendSend a fresh owner invitation to the same email or phoneGET /v1/hq/organizations/{organizationId}/paymentsAn organisation’s online-payments setupPUT /v1/hq/organizations/{organizationId}/payments/payeeOnboard or correct an organisation’s payeePOST /v1/hq/organizations/{organizationId}/payments/payee/refreshAsk the payment provider where it is with an organisation’s payeeGET /v1/hq/organizations/{organizationId}/settingsRead one organisation’s settings, as HQPUT /v1/hq/organizations/{organizationId}/settingsSet, lock or unlock an organisation’s settings, as HQPATCH /v1/hq/organizations/{organizationId}/venues/{venueId}/listingSet a venue’s discovery flagsGET /v1/hq/playersSearch every player on the PlatformGET /v1/hq/players/{playerId}One player’s platform recordPOST /v1/hq/players/{playerId}/banBan a person from the PlatformPOST /v1/hq/players/{playerId}/unbanLift a person’s platform banGET /v1/hq/providersThe deployment’s external providers and their statusPOST /v1/hq/providers/{providerId}/testCheck one provider nowGET /v1/hq/settingsRead the platform defaults and locksPUT /v1/hq/settingsChange platform defaults and locksGET /v1/hq/station-fleetThe fleet’s station client versionsGET /v1/hq/station-releasesEvery station release, newest firstPOST /v1/hq/station-releasesRegister a signed station releasePATCH /v1/hq/station-releases/{version}Halt or resume one station releaseGET /v1/hq/station-rolloutsEach channel’s station rolloutPUT /v1/hq/station-rollouts/{channel}Set a channel’s station rolloutGET /v1/hq/venuesEvery venue on the PlatformPOST /v1/invitations/acceptJoin the staff with an invitation linkGET /v1/organizations/{organizationId}/addonsWhat the organisation pays for add-onsGET /v1/organizations/{organizationId}/auditThe organisation’s audit logPOST /v1/organizations/{organizationId}/audit/exportExport the organisation’s audit log as CSVGET /v1/organizations/{organizationId}/business-detailsThe organisation’s legal name, PAN and registered addressPATCH /v1/organizations/{organizationId}/business-detailsComplete or correct the organisation’s business detailsGET /v1/organizations/{organizationId}/coupon-batchesList the organisation’s coupon batchesPOST /v1/organizations/{organizationId}/coupon-batchesCreate a batch of couponsGET /v1/organizations/{organizationId}/custom-appsList the organisation's custom appsPOST /v1/organizations/{organizationId}/custom-appsCreate a custom appPATCH /v1/organizations/{organizationId}/custom-apps/{customAppId}Edit a custom appPOST /v1/organizations/{organizationId}/custom-apps/{customAppId}/archiveArchive a custom appPOST /v1/organizations/{organizationId}/custom-apps/{customAppId}/iconReserve an icon upload for a custom appPOST /v1/organizations/{organizationId}/custom-apps/{customAppId}/icon/{uploadId}/completeConfirm a custom app icon uploadPOST /v1/organizations/{organizationId}/device-pairings/{code}/approveApprove a pairing: bind the PC to a venue and stationGET /v1/organizations/{organizationId}/discount-codesList discount codesPOST /v1/organizations/{organizationId}/discount-codesDefine a discount codePATCH /v1/organizations/{organizationId}/discount-codes/{discountCodeId}Switch a discount code off or onPOST /v1/organizations/{organizationId}/filesStart an uploadGET /v1/organizations/{organizationId}/files/{fileId}Read a filePOST /v1/organizations/{organizationId}/files/{fileId}/completeFinish an uploadGET /v1/organizations/{organizationId}/franchiseesList an organisation's direct franchiseesGET /v1/organizations/{organizationId}/franchisees/{franchiseeId}/venuesRead one of an organisation's franchisees' venuesGET /v1/organizations/{organizationId}/imported-playersPlayers moved from the café’s previous systemGET /v1/organizations/{organizationId}/imported-players/write-offsMoved balances whose claim window ends soon, or has endedPOST /v1/organizations/{organizationId}/imported-players/write-offsWrite off the money of profiles whose claim window has endedGET /v1/organizations/{organizationId}/imported-players/{importedPlayerId}/claim/approversWho can approve this counter claim with their staff PINPOST /v1/organizations/{organizationId}/imported-players/{importedPlayerId}/claim/email-codeSend a code to the email a moved player is claiming with, at the counterGET /v1/organizations/{organizationId}/invitationsInvitations sent, newest firstPOST /v1/organizations/{organizationId}/invitationsInvite someone to the staff, by phone or by emailDELETE /v1/organizations/{organizationId}/invitations/{invitationId}Withdraw an invitationGET /v1/organizations/{organizationId}/membersThe organisation’s staffGET /v1/organizations/{organizationId}/members/{memberId}One member of the staffDELETE /v1/organizations/{organizationId}/members/{memberId}Take someone off the staffGET /v1/organizations/{organizationId}/members/{memberId}/limitsThe limits set on one memberPUT /v1/organizations/{organizationId}/members/{memberId}/limitsSet the limits on one memberDELETE /v1/organizations/{organizationId}/members/{memberId}/pinReset a member’s staff PIN at a venuePUT /v1/organizations/{organizationId}/members/{memberId}/roleGive a member a different rolePUT /v1/organizations/{organizationId}/members/{memberId}/statusSuspend a member, or reinstate onePUT /v1/organizations/{organizationId}/members/{memberId}/venuesChange which venues a member works atGET /v1/organizations/{organizationId}/passes/holdingsPass holdingsPOST /v1/organizations/{organizationId}/passes/holdings/{holdingId}/refundRefund a pass holdingPOST /v1/organizations/{organizationId}/passes/holdings/{holdingId}/voidVoid a pass holdingGET /v1/organizations/{organizationId}/passes/productsThe pass cataloguePOST /v1/organizations/{organizationId}/passes/productsMake a pass productGET /v1/organizations/{organizationId}/passes/products/{productId}One pass productPATCH /v1/organizations/{organizationId}/passes/products/{productId}Edit a pass productPOST /v1/organizations/{organizationId}/passes/products/{productId}/grantStaff grant a passPOST /v1/organizations/{organizationId}/passes/products/{productId}/sellSell a pass to a playerGET /v1/organizations/{organizationId}/playersSearch the organisation’s playersGET /v1/organizations/{organizationId}/players/{playerId}One player, as this organisation sees themPATCH /v1/organizations/{organizationId}/players/{playerId}Add, edit or remove notes and tagsPOST /v1/organizations/{organizationId}/players/{playerId}/banBan a player from every venue of the organisationGET /v1/organizations/{organizationId}/players/{playerId}/bansA player’s bans in this organisation, reasons includedGET /v1/organizations/{organizationId}/players/{playerId}/gamesWhat the player played hereGET /v1/organizations/{organizationId}/players/{playerId}/id-checksA player’s ID checks at this organisationPOST /v1/organizations/{organizationId}/players/{playerId}/id-checksRecord a staff document ID checkGET /v1/organizations/{organizationId}/players/{playerId}/id-checks/{idCheckId}/photoView an ID check’s photoGET /v1/organizations/{organizationId}/players/{playerId}/ordersThe player’s orders hereGET /v1/organizations/{organizationId}/players/{playerId}/passesThe player’s passes hereGET /v1/organizations/{organizationId}/players/{playerId}/pointsThe points the player earned hereGET /v1/organizations/{organizationId}/players/{playerId}/sessionsThe player’s sessions herePOST /v1/organizations/{organizationId}/players/{playerId}/unbanLift a player’s organisation banGET /v1/organizations/{organizationId}/players/{playerId}/walletThe player’s wallet statement herePOST /v1/organizations/{organizationId}/players/{playerId}/wallet/adjustmentsCredit or debit a player’s wallet cashGET /v1/organizations/{organizationId}/players/{playerId}/wallet/balanceRead a player’s wallet balance herePOST /v1/organizations/{organizationId}/players/{playerId}/wallet/online-top-upsTop up a player’s wallet onlinePOST /v1/organizations/{organizationId}/players/{playerId}/wallet/refundsRefund a player’s wallet cash to a tenderPOST /v1/organizations/{organizationId}/players/{playerId}/wallet/top-upsTop up a player’s wallet at the counterGET /v1/organizations/{organizationId}/product-categoriesList the menu categoriesPOST /v1/organizations/{organizationId}/product-categoriesCreate a menu categoryPATCH /v1/organizations/{organizationId}/product-categories/{categoryId}Update a menu categoryGET /v1/organizations/{organizationId}/productsList the menu productsPOST /v1/organizations/{organizationId}/productsCreate a menu productGET /v1/organizations/{organizationId}/products/{productId}Read one menu productPATCH /v1/organizations/{organizationId}/products/{productId}Update a menu productPATCH /v1/organizations/{organizationId}/products/{productId}/availabilityTurn a product on or offGET /v1/organizations/{organizationId}/promotionsList the organisation’s promotionsPOST /v1/organizations/{organizationId}/promotionsDefine an automatic promotionPATCH /v1/organizations/{organizationId}/promotions/{promotionId}Edit an automatic promotionGET /v1/organizations/{organizationId}/reports/daily-summaryThe owners’ daily summary for one business dayPOST /v1/organizations/{organizationId}/reports/daily-summary/sendEmail the daily summary to yourself nowGET /v1/organizations/{organizationId}/reports/overviewReports overview across the organisation’s venuesGET /v1/organizations/{organizationId}/reports/productsProducts: top food and drink, passes sold, play by passes and rate cardGET /v1/organizations/{organizationId}/reports/rangeA named range’s business days at a venueGET /v1/organizations/{organizationId}/reports/revenueRevenue: by day, category and how it was paid; wallets and liabilitiesGET /v1/organizations/{organizationId}/reports/sessionsSessions and occupancy: the hour × weekday heatmap, peaks, by class and zoneGET /v1/organizations/{organizationId}/reports/staffStaff: sales by member, refunds, voids, discounts and compsGET /v1/organizations/{organizationId}/rolesEvery role: the built-in ones and the custom onesPOST /v1/organizations/{organizationId}/rolesMake a custom roleGET /v1/organizations/{organizationId}/roles/{role}One role: its permissions and its limitsPUT /v1/organizations/{organizationId}/roles/{role}Change a custom role’s permissionsDELETE /v1/organizations/{organizationId}/roles/{role}Delete a custom rolePUT /v1/organizations/{organizationId}/roles/{role}/limitsSet the limits a role carriesGET /v1/organizations/{organizationId}/sessions/{sessionId}Read a session its status and time leftPOST /v1/organizations/{organizationId}/sessions/{sessionId}/add-timeAdd a block to a staff-run sessionPOST /v1/organizations/{organizationId}/sessions/{sessionId}/compGrant comp time to a running sessionPOST /v1/organizations/{organizationId}/sessions/{sessionId}/controllersChange the controllers on a staff-run sessionPOST /v1/organizations/{organizationId}/sessions/{sessionId}/endEnd a sessionGET /v1/organizations/{organizationId}/sessions/{sessionId}/ledgerList a session its journal entries, newest firstPOST /v1/organizations/{organizationId}/sessions/{sessionId}/lockLock or unlock a staff-run sessionPOST /v1/organizations/{organizationId}/sessions/{sessionId}/messageMessage the player at their stationPOST /v1/organizations/{organizationId}/sessions/{sessionId}/moveMove a running session to another stationPOST /v1/organizations/{organizationId}/sessions/{sessionId}/quotePreview adding time or changing controllers on a staff-run sessionPOST /v1/organizations/{organizationId}/sessions/{sessionId}/sell-timeSell more time to a running sessionGET /v1/organizations/{organizationId}/sessions/{sessionId}/timelineRead a session its billed segmentsGET /v1/organizations/{organizationId}/settingsRead the organisation’s settings screenPUT /v1/organizations/{organizationId}/settingsChange the organisation’s settingsGET /v1/organizations/{organizationId}/tax-categoriesList the organisation’s tax categoriesPOST /v1/organizations/{organizationId}/tax-categoriesDefine a tax categoryPATCH /v1/organizations/{organizationId}/tax-categories/{taxCategoryId}Edit or archive a tax categoryGET /v1/organizations/{organizationId}/venuesList the organisation's venuesPOST /v1/organizations/{organizationId}/venuesCreate a venueGET /v1/organizations/{organizationId}/venues/{venueId}Read a venuePATCH /v1/organizations/{organizationId}/venues/{venueId}Edit a venuePOST /v1/organizations/{organizationId}/venues/{venueId}/archiveClose a venue for goodGET /v1/organizations/{organizationId}/venues/{venueId}/boot/classesWhat each station class’s PCs bootPUT /v1/organizations/{organizationId}/venues/{venueId}/boot/classes/{classId}Set what a station class’s PCs bootPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/edits/{editId}/discardDiscard an editPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/edits/{editId}/publishPublish an edit as a new versionGET /v1/organizations/{organizationId}/venues/{venueId}/boot/floorBoot state of the PCs on the FloorGET /v1/organizations/{organizationId}/venues/{venueId}/boot/floor-statesThe simple boot state of the PCs on the FloorGET /v1/organizations/{organizationId}/venues/{venueId}/boot/imagesThe venue’s images and game disksPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/imagesA new image: capture it from a reference PC, import one, or make a game disk from a folderPATCH /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}Change an imagePOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/editsEdit an image on one PCPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/make-independentMake an image saved from another independentPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/mergeMerge old versions into a new basePOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/preparePrepare a version againPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/restoreMake an earlier version current againPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/server-editsUpdate a game disk on the boot serverGET /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/versionsAn image’s versions: its restore pointsGET /v1/organizations/{organizationId}/venues/{venueId}/boot/metricsBoot health: per-PC read latency, cache hits, bytes; server uplink and disk queueGET /v1/organizations/{organizationId}/venues/{venueId}/boot/new-pcsPCs that start from the boot server and are not stations yetGET /v1/organizations/{organizationId}/venues/{venueId}/boot/pcsThe venue’s boot PCsPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcsAdd a boot PC by its MACPATCH /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}Assign a boot PCPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/identifyShow a large number on a boot PC’s own screenPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/make-stationMake a new PC a station on the FloorPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/removeRemove a boot PCPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/shader-seedMake a PC’s shader cache its GPU family’s seedPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/rollouts/restart-idleRestart idle PCs onto the current versionGET /v1/organizations/{organizationId}/venues/{venueId}/boot/serversThe venue’s boot serverPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/pairing-codeA pairing code for the venue’s boot serverPATCH /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/{bootServerId}Rename a boot serverPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/{bootServerId}/unpairUnpair a boot serverPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/{bootServerId}/updateInstall the boot server’s downloaded update nowPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/wipesForce-wipe write-back or shader cachesGET /v1/organizations/{organizationId}/venues/{venueId}/business-dayThe business day now, and who holds the drawerGET /v1/organizations/{organizationId}/venues/{venueId}/callsThe venue’s calls for helpPOST /v1/organizations/{organizationId}/venues/{venueId}/calls/{callId}/acknowledgeAnswer a call for help — "On my way"POST /v1/organizations/{organizationId}/venues/{venueId}/calls/{callId}/resolveResolve a call for help — "Done"GET /v1/organizations/{organizationId}/venues/{venueId}/catalogueBrowse the platform catalogue to add to a venue libraryGET /v1/organizations/{organizationId}/venues/{venueId}/counter-upiThe venue’s counter UPI QR detailsGET /v1/organizations/{organizationId}/venues/{venueId}/countersThe venue’s counters and the drawers running at themPOST /v1/organizations/{organizationId}/venues/{venueId}/countersAdd a counterPATCH /v1/organizations/{organizationId}/venues/{venueId}/counters/{counterId}Rename, archive or restore a counterPOST /v1/organizations/{organizationId}/venues/{venueId}/coupons/redeemRedeem a coupon for a playerGET /v1/organizations/{organizationId}/venues/{venueId}/custom-appsThe organisation's custom apps, as a venue adds themGET /v1/organizations/{organizationId}/venues/{venueId}/day-closeReview a business day's takingsPOST /v1/organizations/{organizationId}/venues/{venueId}/day-closeClose a business dayPOST /v1/organizations/{organizationId}/venues/{venueId}/day-close/sign-offSign off a day that closed by itselfPOST /v1/organizations/{organizationId}/venues/{venueId}/drawer/openOpen the cash drawerGET /v1/organizations/{organizationId}/venues/{venueId}/floorThe live floor snapshotGET /v1/organizations/{organizationId}/venues/{venueId}/floor-planRead one floor’s planPUT /v1/organizations/{organizationId}/venues/{venueId}/floor-planSave one floor’s planGET /v1/organizations/{organizationId}/venues/{venueId}/floor/liveThe floor’s live figures: takings today, sessions, occupancyGET /v1/organizations/{organizationId}/venues/{venueId}/food-ordersList a venue’s food ordersPOST /v1/organizations/{organizationId}/venues/{venueId}/food-ordersPlace a food orderGET /v1/organizations/{organizationId}/venues/{venueId}/food-orders/{orderId}Read one food orderPOST /v1/organizations/{organizationId}/venues/{venueId}/food-orders/{orderId}/cancelCancel a placed food orderGET /v1/organizations/{organizationId}/venues/{venueId}/guest-passesThe venue’s guest passesPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/adjustmentsCorrect one item by hand, with a noteGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/alertsLow, out and negative items, and dishes sold out by stockPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/copy-from-venueCopy another venue’s items, packs and recipesGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/countsCounts, open and pastPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/countsStart a full or spot countGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/counts/{countId}One count, with its variance reviewPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/counts/{countId}/cancelDiscard an open countPUT /v1/organizations/{organizationId}/venues/{venueId}/inventory/counts/{countId}/linesEnter counted quantities on an open countPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/counts/{countId}/submitSubmit a count: each variance becomes a movementGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/itemsThe stock listPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/itemsAdd an ingredient or a supplyGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/items/{stockItemId}One stock itemPATCH /v1/organizations/{organizationId}/venues/{venueId}/inventory/items/{stockItemId}Edit a stock item and its packs, or archive itGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/lookupThe item a scanned barcode namesGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/movementsThe stock movement historyGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/products/{productId}/recipesA product’s recipes at the venuePUT /v1/organizations/{organizationId}/venues/{venueId}/inventory/products/{productId}/recipesReplace a product’s recipes at the venueGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/receiptsDeliveries receivedPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/receiptsReceive a deliveryGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/receipts/{receiptId}One deliveryGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/recipesEvery recipe at the venueGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/reports/marginsCost per dish and margin per productGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/reports/usageStock movements over a range of business days, by kindGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/reports/valuationWhat the stock is worth nowGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/reports/varianceWhat counts found over a range of business daysGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/statusIs stock tracked here, and how many items need someoneGET /v1/organizations/{organizationId}/venues/{venueId}/inventory/suppliersThe venue’s suppliersPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/suppliersAdd a supplierPATCH /v1/organizations/{organizationId}/venues/{venueId}/inventory/suppliers/{supplierId}Edit or archive a supplierPOST /v1/organizations/{organizationId}/venues/{venueId}/inventory/usageRecord waste, a staff meal or a supply issueGET /v1/organizations/{organizationId}/venues/{venueId}/kitchen/ticketsThe kitchen display: a venue’s ticketsPOST /v1/organizations/{organizationId}/venues/{venueId}/kitchen/tickets/{ticketId}/printPrint or reprint a kitchen ticketPOST /v1/organizations/{organizationId}/venues/{venueId}/kitchen/tickets/{ticketId}/stateAdvance or recall a kitchen ticketGET /v1/organizations/{organizationId}/venues/{venueId}/libraryList a venue's libraryPOST /v1/organizations/{organizationId}/venues/{venueId}/libraryAdd a catalogue game to a venue libraryGET /v1/organizations/{organizationId}/venues/{venueId}/library/detectedTitles found on the venue’s PCs, not in its libraryGET /v1/organizations/{organizationId}/venues/{venueId}/library/installsThe titles × stations install matrixPOST /v1/organizations/{organizationId}/venues/{venueId}/library/requestsAsk HQ to add a detected title to the cataloguePOST /v1/organizations/{organizationId}/venues/{venueId}/library/rescanAsk stations to rescan what is installed nowPATCH /v1/organizations/{organizationId}/venues/{venueId}/library/{entryId}Edit a venue library entryDELETE /v1/organizations/{organizationId}/venues/{venueId}/library/{entryId}Remove a title from a venue libraryPOST /v1/organizations/{organizationId}/venues/{venueId}/library/{entryId}/installInstall one library app on every PC missing itGET /v1/organizations/{organizationId}/venues/{venueId}/menuRead a venue’s effective menuPATCH /v1/organizations/{organizationId}/venues/{venueId}/menuSet a venue’s menu overridesPATCH /v1/organizations/{organizationId}/venues/{venueId}/menu/products/{productId}/availabilityMark a product sold out, or back on, at one venueGET /v1/organizations/{organizationId}/venues/{venueId}/needs-attentionWhat needs attention at a venueGET /v1/organizations/{organizationId}/venues/{venueId}/offline-sessionsList the sessions the venue’s stations ran offlinePOST /v1/organizations/{organizationId}/venues/{venueId}/offline-sessions/{offlineSessionId}/resolveSettle an offline session that needs attentionGET /v1/organizations/{organizationId}/venues/{venueId}/offline-staff-codesList the venue’s offline staff codesPOST /v1/organizations/{organizationId}/venues/{venueId}/offline-staff-codesIssue offline staff codesPOST /v1/organizations/{organizationId}/venues/{venueId}/offline-staff-codes/{codeId}/revokeRevoke an offline staff codeGET /v1/organizations/{organizationId}/venues/{venueId}/payment-intents/{paymentIntentId}Read an online payment intentPOST /v1/organizations/{organizationId}/venues/{venueId}/payment-intents/{paymentIntentId}/cancelCancel an open online payment intentGET /v1/organizations/{organizationId}/venues/{venueId}/payments/onlineWhether online payments are open at a venuePOST /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/banBan a player from one venueGET /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/creditA player’s on-account positionPUT /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/creditSet a player’s credit limitPOST /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/receivable/settlePay a receivable downPOST /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/receivable/write-offWrite off a receivablePOST /v1/organizations/{organizationId}/venues/{venueId}/players/{playerId}/unbanLift a player’s ban at one venueGET /v1/organizations/{organizationId}/venues/{venueId}/print-jobsThe venue’s recent print jobsGET /v1/organizations/{organizationId}/venues/{venueId}/printersA venue’s printersPOST /v1/organizations/{organizationId}/venues/{venueId}/printersAdd a printerPATCH /v1/organizations/{organizationId}/venues/{venueId}/printers/{printerId}Edit a printerDELETE /v1/organizations/{organizationId}/venues/{venueId}/printers/{printerId}Archive a printerPOST /v1/organizations/{organizationId}/venues/{venueId}/printers/{printerId}/testPrint a test pageGET /v1/organizations/{organizationId}/venues/{venueId}/rate-cardRead a venue’s rate cardPOST /v1/organizations/{organizationId}/venues/{venueId}/rate-cardPublish a new version of a venue’s rate cardGET /v1/organizations/{organizationId}/venues/{venueId}/reports/games-playedGames played: the venue’s most-played titlesGET /v1/organizations/{organizationId}/venues/{venueId}/reports/overviewReports overview: the venue’s canonical metrics for a rangeGET /v1/organizations/{organizationId}/venues/{venueId}/retail/lookupLook up a retail product by barcodeGET /v1/organizations/{organizationId}/venues/{venueId}/salesList a venue’s salesPOST /v1/organizations/{organizationId}/venues/{venueId}/salesCreate a salePOST /v1/organizations/{organizationId}/venues/{venueId}/sales/quotePrice a cart with its promotions before placing itGET /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}Read one salePOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/cancelCancel a salePOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/discountApply a manual staff discount to a salePOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/discount-codeApply a discount code to a saleGET /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/documentRead a sale’s documentGET /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/document/printThe printable documentPOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/document/sendSend a sale’s documentPUT /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/invoice/gstinSet a sale’s B2B buyerPOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/on-accountTake a sale on accountPOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/payment-intentsPay a sale onlinePOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/paymentsTake a tender against a salePOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/receiptPrint or reprint a sale’s receiptPOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/refundsRefund a salePOST /v1/organizations/{organizationId}/venues/{venueId}/sales/{saleId}/refunds/{refundId}/approveApprove a pending refundPOST /v1/organizations/{organizationId}/venues/{venueId}/sessionsAssign a player to a stationPOST /v1/organizations/{organizationId}/venues/{venueId}/sessions/quotePreview the price of a staff-run sessionGET /v1/organizations/{organizationId}/venues/{venueId}/settingsRead a venue’s settings screenPUT /v1/organizations/{organizationId}/venues/{venueId}/settingsChange a venue’s settingsGET /v1/organizations/{organizationId}/venues/{venueId}/shiftsList a venue's shiftsPOST /v1/organizations/{organizationId}/venues/{venueId}/shiftsOpen a shift with a floatGET /v1/organizations/{organizationId}/venues/{venueId}/shifts/currentThe caller's open shift, or the venue's oneGET /v1/organizations/{organizationId}/venues/{venueId}/shifts/{shiftId}Read one shift with its X/Z reportPOST /v1/organizations/{organizationId}/venues/{venueId}/shifts/{shiftId}/joinJoin a shared drawerPOST /v1/organizations/{organizationId}/venues/{venueId}/shifts/{shiftId}/leaveLeave a shared drawerPOST /v1/organizations/{organizationId}/venues/{venueId}/shifts/{shiftId}/movementsRecord a cash movementGET /v1/organizations/{organizationId}/venues/{venueId}/station-classesList a venue's station classesPOST /v1/organizations/{organizationId}/venues/{venueId}/station-classesCreate a station classPATCH /v1/organizations/{organizationId}/venues/{venueId}/station-classes/{classId}Edit a station classGET /v1/organizations/{organizationId}/venues/{venueId}/station-clientsEach station’s client version and update statusGET /v1/organizations/{organizationId}/venues/{venueId}/station-installersThe Clavian Station and Clavian Counter installers to downloadGET /v1/organizations/{organizationId}/venues/{venueId}/stationsList a venue's stationsPOST /v1/organizations/{organizationId}/venues/{venueId}/stationsDefine a stationPATCH /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}Edit a stationPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/alerts/clearClear or snooze a station’s alertsPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/apps/{entryId}/installInstall one library app on one stationPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/client-update/install-nowUpdate a station’s client nowGET /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/displayWhether a staff-run station has a live countdown screenPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/displayLink (or rotate) a staff-run station’s countdown screenDELETE /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/displayRevoke a staff-run station’s countdown screenGET /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/healthA station’s healthGET /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/installedWhich library titles a station has installedPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/lockLock or unlock a stationGET /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/lockdown-testThe latest lockdown test on a stationPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/lockdown-testRun the lockdown test on a stationPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/maintenancePut a station into or out of maintenancePOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/messageMessage a player at a stationPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/offline-codesGenerate an offline code for a stationPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/powerPower a stationPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/recovery-codeIssue a recovery code for station-cli undoPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/removeRemove a stationGET /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/sessionThe session running on a station, if anyPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/setup/skipSkip a station’s start-up setupGET /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/telemetryA station’s telemetryPOST /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/unpairUnpair the PC from a stationGET /v1/organizations/{organizationId}/venues/{venueId}/stations/{stationId}/wake-readinessWhether a station will wake from Wake-on-LANGET /v1/organizations/{organizationId}/venues/{venueId}/tax-registrationRead a venue’s tax registrationPOST /v1/organizations/{organizationId}/venues/{venueId}/tax-registrationRecord a dated change of a venue’s tax modePOST /v1/organizations/{organizationId}/venues/{venueId}/tax-registration/{registrationId}/withdrawWithdraw a scheduled tax changeGET /v1/organizations/{organizationId}/venues/{venueId}/zonesList a venue's zonesPOST /v1/organizations/{organizationId}/venues/{venueId}/zonesCreate a zonePATCH /v1/organizations/{organizationId}/venues/{venueId}/zones/{zoneId}Rename or recolour a zoneGET /v1/organizations/{organizationId}/wallet/top-up-requestsThe kiosk top-ups waiting on the deskPOST /v1/organizations/{organizationId}/wallet/top-up-requests/{requestId}/cancelCancel a kiosk top-up waiting on the deskPOST /v1/organizations/{organizationId}/wallet/top-up-requests/{requestId}/completeTake a kiosk top-up’s money at the deskPOST /v1/realtime/tokenA realtime token for the socket: as a member of an organisation, or as the player