Groove Restricted

Resolve this before you come in.

This desk keeps a single admission problem. It is exact. Rounding commentary, spaces, and separators are refused.

Ramanujan noticed that this value misses an integer by less than one part in a trillion. Write that integer.

Back to docs
API reference

Introduction

One HTTP API for the fan apps, organiser portal, merchant portal, and floor terminals. Send JSON, read the shared envelope, then open a chapter for the methods you need.

Audience Engineering Methods 438 Updated October 2026

How to call it

Use Content-Type: application/json for request bodies. Production base URL is https://api.groove.com.na. Point UAT builds at the UAT Cloud Run host — never mix payment hosts across environments.

Clients and the API

Every product surface talks to the same service.

Response envelope

Always read status first. A wrong password is often HTTP 200 with status: "failed" — that is intentional.

FieldReq.Description
statusYOutcome class: success, failed, or error.
successYBoolean convenience flag. true only when status is success.
statusCodeYApplication code. success uses 00000. Auth failures use 201… integers. HTTP errors use the HTTP status.
messageYHuman-readable explanation suitable for logs or UI.
shortMessageYShort label for compact UI (e.g. SUCCESS, Invalid credentials).
timestampYISO 8601 UTC time the envelope was built.
requestIdYCorrelation id. Also returned as header x-request-id.
dataCPayload on success. null on failed. Absent or null on many errors.
codeCMachine-readable failure code (e.g. INVALID_CREDENTIALS, VALIDATION_ERROR).
pathCRequest path on error envelopes.
errorsCOptional field-level validation details.

Authentication

  1. Call POST /api/auth/login (or Google / Apple) to receive tokens.
  2. Send Authorization: Bearer <accessToken> on protected routes.
  3. When access expires, call POST /api/auth/refresh.
  4. On sign-out, call POST /api/auth/logout.

Browse by chapter

Each chapter lists methods with request fields, an example response, and notes on the data payload.

System3 methodsAuthentication15 methodsOrganisers16 methodsEvents & catalogue50 methodsFan checkout & payments14 methodsMerchants30 methodsCashless, POS & wallets85 methodsFan account & tickets72 methodsFinance reports12 methodsAccess control23 methodsAdmin118 methods

Source of truth

  • Generated from Groove/api/src/routes/* Zod schemas and route registrations.
  • Sample bodies enriched from Groove/api/postman/Groove-API-UAT.postman_collection.json.
  • Regenerate with python3 docs/api/_generate.py.
  • Conventions: Groove/api/docs/API-CONVENTIONS.md.

Lock this page again

API reference · October 2026 · 438 methods