{ "info": { "name": "MyCup API v1", "description": "Generated from the OpenAPI document, which is itself generated from the route\ntable — so this collection cannot describe an endpoint that does not exist.\n\nSet `base_url`, then:\n\n- PARTNER / PLATFORM: set `client_id` and `client_secret`, run Auth > token, and\n copy the `access_token` from the response into the collection variable of the\n same name.\n- PUBLIC: set `public_key` to a publishable key. No token exchange is involved;\n public keys are read-only by construction.\n\nSet `tournament` to a tournament's uuid or url key; almost every partner and\npublic request uses it.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://mycup.app", "type": "string" }, { "key": "client_id", "value": "", "type": "string" }, { "key": "client_secret", "value": "", "type": "string" }, { "key": "access_token", "value": "", "type": "string" }, { "key": "public_key", "value": "", "type": "string" }, { "key": "tournament", "value": "", "type": "string" } ], "item": [ { "name": "Authentication", "item": [ { "name": "Describe the calling credential and the tournaments it reaches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/me", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "me" ] }, "description": "" } }, { "name": "Revoke the presented access token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/oauth/revoke", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "oauth", "revoke" ] }, "description": "" } }, { "name": "Exchange credentials for an access token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/oauth/token", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "oauth", "token" ] }, "description": "The `client_credentials` grant, and the only grant. Credentials may travel in the body or as HTTP Basic. An unknown client_id and a wrong secret return the same error on purpose." } } ] }, { "name": "Public", "item": [ { "name": "Get the tournament", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}" ] }, "description": "" } }, { "name": "List announcements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/announcements", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "announcements" ] }, "description": "" } }, { "name": "Top assist providers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "assistants" ] }, "description": "" } }, { "name": "List divisions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/divisions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "divisions" ] }, "description": "Returns an empty list for a tournament with one division or none — the same rule the website follows, so a front-end built on this API does not sprout a filter with one option in it." } }, { "name": "List documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/documents", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "documents" ] }, "description": "" } }, { "name": "List matchdays", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/matchdays", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "matchdays" ] }, "description": "" } }, { "name": "List fixtures", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/matches", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "matches" ] }, "description": "" } }, { "name": "Get the match", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/matches/{match}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "matches", "{match}" ] }, "description": "" } }, { "name": "List phases", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/phases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "phases" ] }, "description": "" } }, { "name": "Standings for one phase", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/phases/{phase}/standings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "phases", "{phase}", "standings" ] }, "description": "" } }, { "name": "Get the player", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/players/{player}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "players", "{player}" ] }, "description": "" } }, { "name": "Top scorers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/scorers", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "scorers" ] }, "description": "" } }, { "name": "List sponsors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/sponsors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "sponsors" ] }, "description": "" } }, { "name": "Get the staff member", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/staff/{staff}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "staff", "{staff}" ] }, "description": "" } }, { "name": "Standings for every phase", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/standings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "standings" ] }, "description": "One call rather than discovering the phases and fanning out. Each table carries its tiebreaker chain, because a table sorted by rules the client cannot see eventually gets re-sorted wrongly." } }, { "name": "The tournament structure", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/structure", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "structure" ] }, "description": "" } }, { "name": "The end-of-tournament recap", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/summary", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "summary" ] }, "description": "Champions and podium come from the winners the organiser set in the Website editor, never inferred from standings — a custom bracket's champion is a decision, and deriving it from a table has been wrong often enough to be a rule. Returns 404 until the recap is published." } }, { "name": "List teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/teams", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "teams" ] }, "description": "" } }, { "name": "Get the team", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/teams/{team}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "teams", "{team}" ] }, "description": "" } }, { "name": "List a team's players", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/teams/{team}/players", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "teams", "{team}", "players" ] }, "description": "" } }, { "name": "List a team's staff", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/teams/{team}/staff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "teams", "{team}", "staff" ] }, "description": "" } }, { "name": "List venues", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/venues", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "venues" ] }, "description": "" } }, { "name": "Get the venue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-MyCup-Key", "value": "{{public_key}}" } ], "url": { "raw": "{{base_url}}/api/v1/public/tournaments/{{tournament}}/venues/{venue}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "public", "tournaments", "{{tournament}}", "venues", "{venue}" ] }, "description": "" } } ] }, { "name": "Partner", "item": [ { "name": "Get the tournament", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}" ] }, "description": "Requires scope: tournaments:read or platform:tournaments:read" } }, { "name": "Update the tournament", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}" ] }, "description": "Requires scope: tournaments:write or platform:tournaments:write" } }, { "name": "One group, in one accommodation, for one range of nights", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/accommodation-bookings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "accommodation-bookings" ] }, "description": "`check_out` is the morning they leave, so the last night charged is the day before it; `nights` publishes that count rather than leaving it to be inferred.\n\nCANCELLED bookings are returned by default. Their rooms went back to the allotment when they were cancelled, but the row stays because it is the list of who needs re-housing — filter on `status` if you only want live ones.\n\n`beds` is capacity, not people. Compare it against the group's `headcount`: if the group is larger, somebody has nowhere to sleep.\n\nRequires scope: hospitality:read or platform:tournaments:read" } }, { "name": "Get the accommodation booking", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/accommodation-bookings/{booking}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "accommodation-bookings", "{booking}" ] }, "description": "Requires scope: hospitality:read or platform:tournaments:read" } }, { "name": "The rooming list for one booking", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/accommodation-bookings/{booking}/rooming", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "accommodation-bookings", "{booking}", "rooming" ] }, "description": "⚠️ ID NUMBERS AND DATES OF BIRTH ARE DELIBERATELY NOT RETURNED.\n\nA rooming list holds passport numbers and dates of birth, very often of children. Inside MyCup the ID number is stored encrypted and both are purged on a schedule once the tournament is over. An API field would be a third copy leaving the building on every poll, with no consent story and no retention story.\n\nWhat is published instead is the SHAPE of the list and its COMPLETENESS: which room, who is in it, and `is_complete` — false when a passport number or date of birth is still missing, which is the thing an integration is chasing. `is_complete` is the same predicate the organiser sees, so the two cannot disagree about which list is ready.\n\nThe identifying data continues to leave by the one audited route it already had: the organiser downloading the sheet and sending it to the hotel that asked for it.\n\nRequires scope: hospitality:read or platform:tournaments:read" } }, { "name": "Hotels, hostels and schools, with the room types they are holding", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/accommodations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "accommodations" ] }, "description": "The whole Hospitality surface (accommodation and meals) is READ ONLY and requires `hospitality:read`.\n\nUnlike the finance surface next door, the READS here are plan-gated too. A balance is a debt a club was already told about; a hotel contract — which accommodation, at what rate, through which named contact — is the commercial information the plan sells access to.\n\n`units_contracted` is what the hotel holds for you. What is LEFT is not here, because it is only meaningful for a date: ask `/availability`.\n\nRequires scope: hospitality:read or platform:tournaments:read" } }, { "name": "Get the accommodation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/accommodations/{accommodation}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "accommodations", "{accommodation}" ] }, "description": "Requires scope: hospitality:read or platform:tournaments:read" } }, { "name": "What is left of each room type, night by night", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/accommodations/{accommodation}/availability", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "accommodations", "{accommodation}", "availability" ] }, "description": "Counted live by AccommodationInventory, the one place a remaining-unit count is worked out, so this can never disagree with the organiser's screen.\n\nThe range is HALF-OPEN: `to` is the morning people leave, so the last night counted is the day before it — the same convention a booking uses. `remaining_across` is the TIGHTEST night in the range, which is what decides whether a stay fits: a room free on three nights of four is not a room you can book for four.\n\nA negative number is a real answer, not an error. Booking past a hotel's allotment is allowed on purpose and warned about rather than blocked.\n\nThe range is CAPPED AT 90 NIGHTS. It drives a night-by-night walk, so an uncapped `?from=2020-01-01&to=2030-01-01` is ~3,650 nights times room types in one response. A longer range is a `422`, not a truncated answer — 90 nights is longer than any festival this surface was built for.\n\nRequires scope: hospitality:read or platform:tournaments:read" } }, { "name": "List announcements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/announcements", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "announcements" ] }, "description": "Requires scope: website:read or platform:tournaments:read" } }, { "name": "Create an announcement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/announcements", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "announcements" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Update the announcement", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/announcements/{announcement}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "announcements", "{announcement}" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Delete the announcement", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/announcements/{announcement}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "announcements", "{announcement}" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "List assistants", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "assistants" ] }, "description": "Requires scope: results:read or platform:tournaments:read" } }, { "name": "Proforma invoices raised for participants", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/booking-forms", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "booking-forms" ] }, "description": "READ ONLY. Sending a booking form claims a document number, freezes every price, writes real debt to a participant's balance and emails a PDF in the organiser's name — four irreversible things in one step, in the organiser's own document series — so there is no write route and therefore no write scope.\n\nA DRAFT has no `number`: it genuinely has none until it is sent, which is what keeps the series gapless. `issuer` and `client` are the blocks frozen at send and are null before it.\n\n⚠️ An instalment's `percent` is a FRACTION of 1 — half is `0.5`. `percent_display` carries the same value as the number an organiser typed (50), for rendering.\n\nNot plan-gated, for the same reason reading a balance is not.\n\nRequires scope: finances:read or platform:tournaments:read" } }, { "name": "Get the booking form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/booking-forms/{document}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "booking-forms", "{document}" ] }, "description": "Requires scope: finances:read or platform:tournaments:read" } }, { "name": "List candidates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/candidates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "candidates" ] }, "description": "Requires scope: candidates:read or platform:tournaments:read" } }, { "name": "Get the candidate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/candidates/{candidate}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "candidates", "{candidate}" ] }, "description": "Requires scope: candidates:read or platform:tournaments:read" } }, { "name": "Update the candidate", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/candidates/{candidate}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "candidates", "{candidate}" ] }, "description": "Requires scope: candidates:write or platform:tournaments:write" } }, { "name": "Delete the candidate", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/candidates/{candidate}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "candidates", "{candidate}" ] }, "description": "Requires scope: candidates:write or platform:tournaments:write" } }, { "name": "Convert a registration into a participant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/candidates/{candidate}/convert", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "candidates", "{candidate}", "convert" ] }, "description": "Creates the team, copies the logo into the team's storage and sends the confirmation email, in one transaction. Refused with `402` if the plan's participant cap is already reached.\n\nRequires scope: candidates:write or teams:write or platform:tournaments:write" } }, { "name": "Reject a registration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/candidates/{candidate}/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "candidates", "{candidate}", "reject" ] }, "description": "Marks the candidate rejected. A candidate that has already been converted cannot be rejected — delete the participant instead.\n\nRequires scope: candidates:write or platform:tournaments:write" } }, { "name": "List custom attributes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/custom-attributes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "custom-attributes" ] }, "description": "Requires scope: custom-attributes:read or platform:tournaments:read" } }, { "name": "Create a custom attribute", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/custom-attributes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "custom-attributes" ] }, "description": "Requires scope: custom-attributes:write or platform:tournaments:write" } }, { "name": "Get the custom attribute", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/custom-attributes/{attribute}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "custom-attributes", "{attribute}" ] }, "description": "Requires scope: custom-attributes:read or platform:tournaments:read" } }, { "name": "Update the custom attribute", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/custom-attributes/{attribute}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "custom-attributes", "{attribute}" ] }, "description": "Requires scope: custom-attributes:write or platform:tournaments:write" } }, { "name": "Delete the custom attribute", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/custom-attributes/{attribute}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "custom-attributes", "{attribute}" ] }, "description": "Requires scope: custom-attributes:write or platform:tournaments:write" } }, { "name": "List divisions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/divisions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "divisions" ] }, "description": "Requires scope: divisions:read or platform:tournaments:read" } }, { "name": "Create a division", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/divisions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "divisions" ] }, "description": "Requires scope: divisions:write or platform:tournaments:write" } }, { "name": "Get the division", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/divisions/{division}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "divisions", "{division}" ] }, "description": "Requires scope: divisions:read or platform:tournaments:read" } }, { "name": "Update the division", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/divisions/{division}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "divisions", "{division}" ] }, "description": "Requires scope: divisions:write or platform:tournaments:write" } }, { "name": "Delete the division", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/divisions/{division}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "divisions", "{division}" ] }, "description": "Requires scope: divisions:write or platform:tournaments:write" } }, { "name": "Upload the division logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/divisions/{division}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "divisions", "{division}", "logo" ] }, "description": "Requires scope: divisions:write or platform:tournaments:write" } }, { "name": "Remove the division logo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/divisions/{division}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "divisions", "{division}", "logo" ] }, "description": "Requires scope: divisions:write or platform:tournaments:write" } }, { "name": "List documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/documents", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "documents" ] }, "description": "Requires scope: website:read or platform:tournaments:read" } }, { "name": "Publish a document link", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/documents", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "documents" ] }, "description": "Links only. Uploaded files remain a panel action: they live on a private disk and are served through a controller that re-checks the plan and the page setting on every request.\n\nRequires scope: website:write or platform:tournaments:write" } }, { "name": "Update the document", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/documents/{document}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "documents", "{document}" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Delete the document", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/documents/{document}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "documents", "{document}" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Every charge template this tournament uses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/fees", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "fees" ] }, "description": "`pricing_mode` decides what the amount is PER, and changes what the fee means entirely. `flat` bills its amount once; `per_person` bills it per head and is NOT directly applicable — it belongs on a booking form, where the pax figure is stated. `directly_applicable` is the same answer as a boolean, for clients that would rather branch on it than on the enum.\n\nRequires scope: finances:read or platform:tournaments:read" } }, { "name": "Create a fee", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/fees", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "fees" ] }, "description": "A fee carries its deadline as an OFFSET (`due_days`, counted from the day each participant is billed) or a FIXED DATE (`due_on`), never both — sending one clears the other. Sending neither means this fee has no deadline, and a charge with no deadline is never chased automatically.\n\nRequires scope: finances:write or platform:tournaments:write" } }, { "name": "Get the fee", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/fees/{fee}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "fees", "{fee}" ] }, "description": "Requires scope: finances:read or platform:tournaments:read" } }, { "name": "Update the fee", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/fees/{fee}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "fees", "{fee}" ] }, "description": "Requires scope: finances:write or platform:tournaments:write" } }, { "name": "Delete the fee", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/fees/{fee}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "fees", "{fee}" ] }, "description": "Requires scope: finances:write or platform:tournaments:write" } }, { "name": "Raise this fee as a charge against participants", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/fees/{fee}/apply", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "fees", "{fee}", "apply" ] }, "description": "Goes through FeeApplier, which locks the fee row, refuses to bill a participant it has already billed for this fee, and resolves the deadline through the one method that knows the offset-vs-fixed-date distinction.\n\nReturns how many charges were `created` and how many participants were `skipped` because they already carried one.\n\nRequires scope: finances:write or platform:tournaments:write" } }, { "name": "What each participant owes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/finance-balances", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "finance-balances" ] }, "description": "Computed by FinanceLedger, the only place this arithmetic lives. All amounts are MINOR UNITS (integer cents) as stored — no float ever touches a balance.\n\nReading a balance is NOT plan-gated, unlike every finance write: an organiser whose plan lapsed must still be able to see what they are owed.\n\nRequires scope: finances:read or platform:tournaments:read" } }, { "name": "List finance entries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/finance-entries", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "finance-entries" ] }, "description": "Requires scope: finances:read or platform:tournaments:read" } }, { "name": "Record a charge, payment or refund", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/finance-entries", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "finance-entries" ] }, "description": "Entries created here are CONFIRMED: a credential acting for the organiser is recording a decision already made. The `pending` state exists for a club's self-reported payment, which arrives through the participant panel and cannot be created from this surface.\n\nRequires scope: finances:write or platform:tournaments:write" } }, { "name": "Get the finance entry", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/finance-entries/{entry}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "finance-entries", "{entry}" ] }, "description": "Requires scope: finances:read or platform:tournaments:read" } }, { "name": "Update the finance entry", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/finance-entries/{entry}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "finance-entries", "{entry}" ] }, "description": "Requires scope: finances:write or platform:tournaments:write" } }, { "name": "Delete the finance entry", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/finance-entries/{entry}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "finance-entries", "{entry}" ] }, "description": "Requires scope: finances:write or platform:tournaments:write" } }, { "name": "List grounds availability", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/grounds/{ground}/availability", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "grounds", "{ground}", "availability" ] }, "description": "Requires scope: venues:read or platform:tournaments:read" } }, { "name": "Declare when a venue is free", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/grounds/{ground}/availability", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "grounds", "{ground}", "availability" ] }, "description": "Writing a window schedules NOTHING. MatchScheduler is the only thing that writes a kickoff time, so opening hours can be declared without any fixture moving until auto-fill is asked for.\n\n`slot_minutes` is required and is the single source of truth for how long a match occupies this venue. Sport config (periods x duration) drives the match-editor clock and deliberately does not feed scheduling.\n\nRequires scope: venues:write or platform:tournaments:write" } }, { "name": "Update the grounds availability", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/grounds/{ground}/availability/{availability}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "grounds", "{ground}", "availability", "{availability}" ] }, "description": "Requires scope: venues:write or platform:tournaments:write" } }, { "name": "Delete the grounds availability", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/grounds/{ground}/availability/{availability}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "grounds", "{ground}", "availability", "{availability}" ] }, "description": "Requires scope: venues:write or platform:tournaments:write" } }, { "name": "Who is travelling, as the units that need beds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/hospitality-groups", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "hospitality-groups" ] }, "description": "⚠️ A GROUP IS NOT A TEAM. A club of 18 can arrive as three groups — the squad in a hostel, the coaches in a hotel, twenty parents in family rooms — and referees are a group belonging to no club at all. `team_id` is therefore nullable by design; it is what links a group's costs to a participant's balance.\n\nCalled a group here because that is the word the panel, the emails and the documentation use. The model is named `Party` only to avoid colliding with a group STAGE.\n\nRequires scope: hospitality:read or platform:tournaments:read" } }, { "name": "Get the hospitality group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/hospitality-groups/{group}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "hospitality-groups", "{group}" ] }, "description": "Requires scope: hospitality:read or platform:tournaments:read" } }, { "name": "List the club library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/library/clubs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "library", "clubs" ] }, "description": "The LIBRARY is one entry per club, player and staff member across every season of this tournament. Each season's row points at its entry through `library_id` (on teams, players and staff in partner responses only — never on the public surface, because it links one child's records across seasons).\n\nThe library fills itself: a next season copies its rows already linked, and a row added later links to its entry when exactly one entry matches, becomes a new entry when none does, and is left unlinked only when the match is ambiguous.\n\n`seasons` lists the tournaments (id) each entry appears in, oldest first.\n\nA credential attached to SOME seasons sees the library through them only: an entry is listed when it has a row in a season the credential reaches, and `seasons` names only those. Linking to an entry it could not list is refused like another tournament's entry (422).\n\nRequires scope: teams:read or platform:tournaments:read" } }, { "name": "List the player library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/library/players", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "library", "players" ] }, "description": "See the club library. People carry `birth_year` (the year only, enough to tell namesakes apart). Anonymised people are left out.\n\nRequires scope: players:read or platform:tournaments:read" } }, { "name": "Likely duplicate players in the library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/library/players/duplicates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "library", "players", "duplicates" ] }, "description": "Groups of two or more entries with the same name whose birth dates do not disagree, minus pairs marked as different people. A suggestion, never an automatic merge: two children of one name at one club are real.\n\nRequires scope: players:read or platform:tournaments:read" } }, { "name": "Mark two players as different people", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/library/players/{entry}/distinct", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "library", "players", "{entry}", "distinct" ] }, "description": "The pair is never suggested as a duplicate again. Returns 403 `tournament_not_in_scope` when either person also has a row in a season this credential does not reach.\n\nRequires scope: players:write or platform:tournaments:write" } }, { "name": "Merge a duplicate player into another", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/library/players/{entry}/merge", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "library", "players", "{entry}", "merge" ] }, "description": "Every season row of the duplicate (the path entry) now points at `into`, blanks on `into` are filled from the duplicate, and the duplicate is deleted. Only the library changes: numbers, goals, lineups and documents stay exactly as each season recorded them. Returns 403 `tournament_not_in_scope` when either person also has a row in a season this credential does not reach.\n\nRequires scope: players:write or platform:tournaments:write" } }, { "name": "List the staff library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/library/staff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "library", "staff" ] }, "description": "See the club library. Anonymised people are left out.\n\nRequires scope: staff:read or platform:tournaments:read" } }, { "name": "Upload the tournament logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "logo" ] }, "description": "Requires scope: tournaments:write or platform:tournaments:write" } }, { "name": "Remove the tournament logo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "logo" ] }, "description": "Requires scope: tournaments:write or platform:tournaments:write" } }, { "name": "List fixtures", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches" ] }, "description": "Requires scope: matches:read or platform:tournaments:read" } }, { "name": "Generate the fixture list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/generate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "generate" ] }, "description": "DESTRUCTIVE. Existing matches are soft-deleted and rebuilt from the current team slots, taking their events, lineups and referee assignments with them. If anything would be lost the call is refused with `409 destructive_confirmation_required` listing what would go; repeat with `confirm_destructive: true`.\n\nThere is no endpoint for creating a single match: matches exist because a structure was generated, and a hand-made fixture would belong to no group and count towards no table.\n\nRequires scope: matches:write or platform:tournaments:write" } }, { "name": "Get the match", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/{match}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "{match}" ] }, "description": "Requires scope: matches:read or platform:tournaments:read" } }, { "name": "Move or restate a fixture", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/{match}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "{match}" ] }, "description": "Kickoff time, venue, status and description. Set `is_schedule_locked` to pin a match so auto-fill, regeneration and \"clear schedule\" leave it alone.\n\nRequires scope: matches:write or platform:tournaments:write" } }, { "name": "List a match's events", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/{match}/events", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "{match}", "events" ] }, "description": "Requires scope: results:read or platform:tournaments:read" } }, { "name": "Record a match event", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/{match}/events", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "{match}", "events" ] }, "description": "A goal, card or substitution as its own row, so a live-scoring integration can post one the moment it happens instead of resubmitting the whole match. `event_code` is validated against this SPORT's event list — a handball tournament genuinely has no yellow-red card.\n\nRequires scope: results:write or platform:tournaments:write" } }, { "name": "Update the event", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/{match}/events/{event}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "{match}", "events", "{event}" ] }, "description": "Requires scope: results:write or platform:tournaments:write" } }, { "name": "Delete the event", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/{match}/events/{event}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "{match}", "events", "{event}" ] }, "description": "Requires scope: results:write or platform:tournaments:write" } }, { "name": "Record a match result", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/matches/{match}/result", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "matches", "{match}", "result" ] }, "description": "Scores, extra time, penalties and technical results. A set-scored sport must send `sets` and is refused if it sends `home_score` — the match score there is SETS WON, derived from the per-set rows.\n\nSeparate from PATCH /matches/{match}, which moves a fixture: a score is governed by the results capability, a kickoff time by the schedule one, and a finished tournament still allows both.\n\nRequires scope: results:write or platform:tournaments:write" } }, { "name": "Sittings, and how many of each group is eating", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/meal-services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "meal-services" ] }, "description": "⚠️ `headcount` is TYPED by the organiser, never derived from a roster. Clubs arrive late and miss a dinner, families booked half board and eat in town, and Sunday's squad is nine players because the rest went home after the semi-final. A client that recomputes these from group sizes will disagree with the number the caterer was given — which is the number that gets cooked and paid for.\n\n`total_headcount` is the figure a caterer asks for.\n\nRequires scope: hospitality:read or platform:tournaments:read" } }, { "name": "Get the meal service", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/meal-services/{meal}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "meal-services", "{meal}" ] }, "description": "Requires scope: hospitality:read or platform:tournaments:read" } }, { "name": "The tournament's plan, its caps and what remains", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/plan", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "plan" ] }, "description": "Read this to refuse locally instead of discovering a cap through a 402 halfway through an import.\n\nRequires scope: plan:read or tournaments:read or platform:tournaments:read" } }, { "name": "List referees", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/referees", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "referees" ] }, "description": "Requires scope: referees:read or platform:tournaments:read" } }, { "name": "Create a referee", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/referees", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "referees" ] }, "description": "Requires scope: referees:write or platform:tournaments:write" } }, { "name": "Get the referee", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/referees/{referee}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "referees", "{referee}" ] }, "description": "Requires scope: referees:read or platform:tournaments:read" } }, { "name": "Update the referee", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/referees/{referee}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "referees", "{referee}" ] }, "description": "Requires scope: referees:write or platform:tournaments:write" } }, { "name": "Delete the referee", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/referees/{referee}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "referees", "{referee}" ] }, "description": "Requires scope: referees:write or platform:tournaments:write" } }, { "name": "Upload the referee photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/referees/{referee}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "referees", "{referee}", "photo" ] }, "description": "Requires scope: referees:write or platform:tournaments:write" } }, { "name": "Remove the referee photo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/referees/{referee}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "referees", "{referee}", "photo" ] }, "description": "Requires scope: referees:write or platform:tournaments:write" } }, { "name": "Apply a proposed schedule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/schedule/apply", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "schedule", "apply" ] }, "description": "Recomputes the proposal server-side and accepts only your `fingerprint` as proof that nothing moved in between. A stale fingerprint is refused rather than allowed to double-book a pitch.\n\nRequires scope: schedule:write or platform:tournaments:write" } }, { "name": "List scheduling clashes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/schedule/conflicts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "schedule", "conflicts" ] }, "description": "Two matches on one venue at one time, or a team in two places at once. `matches_in_conflict` counts MATCHES, not conflicts, which is the question an organiser is actually asking.\n\nRequires scope: schedule:read or platform:tournaments:read" } }, { "name": "Propose a venue-aware schedule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/schedule/propose", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "schedule", "propose" ] }, "description": "WRITES NOTHING. Returns the placements plus every match it could not seat WITH A REASON — `division_venue`, `round_order`, `rest`, `max_per_day`, `team_busy`, `no_slot` — each of which points at a different remedy. Pass the returned `fingerprint` to /schedule/apply.\n\nRequires scope: schedule:read or platform:tournaments:read" } }, { "name": "Top scorers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/scorers", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "scorers" ] }, "description": "Requires scope: results:read or platform:tournaments:read" } }, { "name": "List the seasons of this tournament", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/seasons", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "seasons" ] }, "description": "Every season, oldest first, including this one. `is_current` marks the season the tournament is on; `reachable` says whether THIS credential is attached to that season, since a credential reaches only the seasons it was given. A tournament with no other seasons returns itself alone.\n\nRequires scope: tournaments:read or platform:tournaments:read" } }, { "name": "List sponsors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/sponsors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "sponsors" ] }, "description": "Requires scope: website:read or platform:tournaments:read" } }, { "name": "Create a sponsor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/sponsors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "sponsors" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Update the sponsor", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/sponsors/{sponsor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "sponsors", "{sponsor}" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Delete the sponsor", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/sponsors/{sponsor}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "sponsors", "{sponsor}" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Upload the sponsor logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/sponsors/{sponsor}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "sponsors", "{sponsor}", "logo" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "Remove the sponsor logo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/sponsors/{sponsor}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "sponsors", "{sponsor}", "logo" ] }, "description": "Requires scope: website:write or platform:tournaments:write" } }, { "name": "List standings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/standings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "standings" ] }, "description": "Requires scope: results:read or platform:tournaments:read" } }, { "name": "List statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/statistics", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "statistics" ] }, "description": "Requires scope: statistics:read or platform:tournaments:read" } }, { "name": "The tournament structure", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/structure", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "structure" ] }, "description": "Requires scope: structure:read or platform:tournaments:read" } }, { "name": "Replace the tournament structure", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/structure", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "structure" ] }, "description": "Does NOT regenerate matches. Call POST /matches/generate explicitly, so adjusting one group cannot silently destroy a weekend of results.\n\nRequires scope: structure:write or platform:tournaments:write" } }, { "name": "Preview a structure without saving it", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/structure/preview", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "structure", "preview" ] }, "description": "Turns \"8 teams, 2 groups, knockout from the quarters\" into the same form-data shape PUT /structure expects, so an organiser can see what they are about to commit to before anything is written.\n\nRequires scope: structure:read or platform:tournaments:read" } }, { "name": "List team forms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/team-forms", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "team-forms" ] }, "description": "Requires scope: forms:read or platform:tournaments:read" } }, { "name": "Create a team form", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/team-forms", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "team-forms" ] }, "description": "Requires scope: forms:write or platform:tournaments:write" } }, { "name": "Get the team form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/team-forms/{form}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "team-forms", "{form}" ] }, "description": "Requires scope: forms:read or platform:tournaments:read" } }, { "name": "Update a form", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/team-forms/{form}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "team-forms", "{form}" ] }, "description": "`fields` replaces the whole set when present. Omitting it leaves the fields alone, so renaming a form does not require resending every field; sending an empty array really does clear them.\n\nBecause it REPLACES rather than merges, two clients doing read-modify-write silently overwrite each other. Send `expected_version` (the `version` from your last read) to be refused with `409 form_modified` instead of losing the other edit. It is a content hash, not a timestamp: `updated_at` is second-precision and cannot detect a same-second change.\n\nRequires scope: forms:write or platform:tournaments:write" } }, { "name": "Delete the team form", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/team-forms/{form}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "team-forms", "{form}" ] }, "description": "Requires scope: forms:write or platform:tournaments:write" } }, { "name": "Every participant's answers to this form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/team-forms/{form}/responses", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "team-forms", "{form}", "responses" ] }, "description": "Read-only. A response is the participant's own statement, made in their panel; an organiser credential that could write one would answer on the club's behalf and leave no trace that it had.\n\nAnswers are keyed by FIELD ID, never by label — a label is editable text, and keying on it would re-point every historical answer the first time somebody fixes a typo.\n\nRequires scope: forms:read or platform:tournaments:read" } }, { "name": "List teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams" ] }, "description": "Requires scope: teams:read or platform:tournaments:read" } }, { "name": "Create a team", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams" ] }, "description": "Requires scope: teams:write or platform:tournaments:write" } }, { "name": "Get the team", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}" ] }, "description": "Requires scope: teams:read or platform:tournaments:read" } }, { "name": "Update the team", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}" ] }, "description": "Requires scope: teams:write or platform:tournaments:write" } }, { "name": "Delete the team", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}" ] }, "description": "Requires scope: teams:write or platform:tournaments:write" } }, { "name": "Link a team to its club library entry", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/library", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "library" ] }, "description": "Sets which library entry this season's team is. `library_id` is an entry of this tournament's library, `\"new\"` for a new entry, or `null` to unlink. An entry nothing points at any more is removed. Returns 409 `not_a_season` when the tournament has no library.\n\nRequires scope: teams:write or platform:tournaments:write" } }, { "name": "Upload the team logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "logo" ] }, "description": "Requires scope: teams:write or platform:tournaments:write" } }, { "name": "Remove the team logo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "logo" ] }, "description": "Requires scope: teams:write or platform:tournaments:write" } }, { "name": "Upload the team photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "photo" ] }, "description": "Requires scope: teams:write or platform:tournaments:write" } }, { "name": "Remove the team photo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "photo" ] }, "description": "Requires scope: teams:write or platform:tournaments:write" } }, { "name": "List a team's players", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/players", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "players" ] }, "description": "Requires scope: players:read or platform:tournaments:read" } }, { "name": "Create a player", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/players", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "players" ] }, "description": "Requires scope: players:write or platform:tournaments:write" } }, { "name": "Update the player", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/players/{player}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "players", "{player}" ] }, "description": "Requires scope: players:write or platform:tournaments:write" } }, { "name": "Delete the player", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/players/{player}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "players", "{player}" ] }, "description": "Requires scope: players:write or platform:tournaments:write" } }, { "name": "Link a player to their library entry", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/players/{player}/library", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "players", "{player}", "library" ] }, "description": "As for teams: an entry id, `\"new\"`, or `null` to unlink.\n\nRequires scope: players:write or platform:tournaments:write" } }, { "name": "Upload the player photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/players/{player}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "players", "{player}", "photo" ] }, "description": "Requires scope: players:write or platform:tournaments:write" } }, { "name": "Remove the player photo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/players/{player}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "players", "{player}", "photo" ] }, "description": "Requires scope: players:write or platform:tournaments:write" } }, { "name": "List a team's staff", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/staff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "staff" ] }, "description": "Requires scope: staff:read or platform:tournaments:read" } }, { "name": "Create a staff member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/staff", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "staff" ] }, "description": "Requires scope: staff:write or platform:tournaments:write" } }, { "name": "Update the staff member", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/staff/{staff}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "staff", "{staff}" ] }, "description": "Requires scope: staff:write or platform:tournaments:write" } }, { "name": "Delete the staff member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/staff/{staff}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "staff", "{staff}" ] }, "description": "Requires scope: staff:write or platform:tournaments:write" } }, { "name": "Link a staff member to their library entry", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/staff/{staff}/library", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "staff", "{staff}", "library" ] }, "description": "As for teams: an entry id, `\"new\"`, or `null` to unlink.\n\nRequires scope: staff:write or platform:tournaments:write" } }, { "name": "Upload the staff member photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/staff/{staff}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "staff", "{staff}", "photo" ] }, "description": "Requires scope: staff:write or platform:tournaments:write" } }, { "name": "Remove the staff member photo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/teams/{team}/staff/{staff}/photo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "teams", "{team}", "staff", "{staff}", "photo" ] }, "description": "Requires scope: staff:write or platform:tournaments:write" } }, { "name": "List venues", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/venues", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "venues" ] }, "description": "Requires scope: venues:read or platform:tournaments:read" } }, { "name": "Create a venue", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/venues", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "venues" ] }, "description": "Requires scope: venues:write or platform:tournaments:write" } }, { "name": "Get the venue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/venues/{venue}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "venues", "{venue}" ] }, "description": "Requires scope: venues:read or platform:tournaments:read" } }, { "name": "Update the venue", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/venues/{venue}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "venues", "{venue}" ] }, "description": "Requires scope: venues:write or platform:tournaments:write" } }, { "name": "Delete the venue", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/venues/{venue}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "venues", "{venue}" ] }, "description": "Requires scope: venues:write or platform:tournaments:write" } }, { "name": "Upload the venue logo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/venues/{venue}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "venues", "{venue}", "logo" ] }, "description": "Requires scope: venues:write or platform:tournaments:write" } }, { "name": "Remove the venue logo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/tournaments/{{tournament}}/venues/{venue}/logo", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "tournaments", "{{tournament}}", "venues", "{venue}", "logo" ] }, "description": "Requires scope: venues:write or platform:tournaments:write" } } ] }, { "name": "Platform", "item": [ { "name": "List announcements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/announcements", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "announcements" ] }, "description": "Requires scope: platform:content:read" } }, { "name": "Create an announcement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/announcements", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "announcements" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "Update the announcement", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/announcements/{announcement}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "announcements", "{announcement}" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "Delete the announcement", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/announcements/{announcement}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "announcements", "{announcement}" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "List api clients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/api-clients", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "api-clients" ] }, "description": "Requires scope: platform:api-clients:read" } }, { "name": "Create an api client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/api-clients", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "api-clients" ] }, "description": "Requires scope: platform:api-clients:write" } }, { "name": "Get the api client", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/api-clients/{client}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "api-clients", "{client}" ] }, "description": "Requires scope: platform:api-clients:read" } }, { "name": "Update the api client", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/api-clients/{client}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "api-clients", "{client}" ] }, "description": "Requires scope: platform:api-clients:write" } }, { "name": "Delete the api client", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/api-clients/{client}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "api-clients", "{client}" ] }, "description": "Requires scope: platform:api-clients:write" } }, { "name": "Revoke the credential", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/api-clients/{client}/revoke", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "api-clients", "{client}", "revoke" ] }, "description": "Requires scope: platform:api-clients:write" } }, { "name": "Rotate the credential secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/api-clients/{client}/rotate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "api-clients", "{client}", "rotate" ] }, "description": "Requires scope: platform:api-clients:write" } }, { "name": "List blog posts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/blog-posts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "blog-posts" ] }, "description": "Requires scope: platform:content:read" } }, { "name": "Create a blog post", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/blog-posts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "blog-posts" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "Get the blog post", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/blog-posts/{post}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "blog-posts", "{post}" ] }, "description": "Requires scope: platform:content:read" } }, { "name": "Update the blog post", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/blog-posts/{post}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "blog-posts", "{post}" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "Delete the blog post", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/blog-posts/{post}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "blog-posts", "{post}" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "List discount codes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discount-codes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discount-codes" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "Create a discount code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discount-codes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discount-codes" ] }, "description": "Requires scope: platform:billing:write" } }, { "name": "Delete the discount code", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discount-codes/{code}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discount-codes", "{code}" ] }, "description": "Requires scope: platform:billing:write" } }, { "name": "List discounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discounts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discounts" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "Create a discount", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discounts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discounts" ] }, "description": "Requires scope: platform:billing:write" } }, { "name": "Get the discount", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discounts/{discount}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discounts", "{discount}" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "Update the discount", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discounts/{discount}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discounts", "{discount}" ] }, "description": "Requires scope: platform:billing:write" } }, { "name": "Delete the discount", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/discounts/{discount}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "discounts", "{discount}" ] }, "description": "Requires scope: platform:billing:write" } }, { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/invoices", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "invoices" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "Estate-wide numbers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/metrics", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "metrics" ] }, "description": "Tournaments, users, one-time orders and revenue. Revenue is what was actually CHARGED (after discounts), not list price.\n\nSubscription metrics (MRR, churn, active subscriptions) are inherited from SaaSykit and describe recurring revenue MyCup does not have. They are returned only with `include_subscription_metrics=1`, and labelled as not applicable.\n\nRequires scope: platform:metrics" } }, { "name": "List one time products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/one-time-products", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "one-time-products" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "Create an one time product", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/one-time-products", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "one-time-products" ] }, "description": "Requires scope: platform:billing:write" } }, { "name": "Get the one time product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/one-time-products/{product}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "one-time-products", "{product}" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "Update the one time product", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/one-time-products/{product}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "one-time-products", "{product}" ] }, "description": "Requires scope: platform:billing:write" } }, { "name": "Withdraw a plan from sale", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/one-time-products/{product}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "one-time-products", "{product}" ] }, "description": "⚠️ Returns **200 with the updated product**, not 204. This is the only DELETE on the API that does — everywhere else DELETE means 204 and gone.\n\nIt deactivates rather than deletes: every order that ever bought this plan still points at it, and PlanManager reads the product behind a purchase to decide what that tournament is entitled to today, so destroying one would strip features from tournaments that paid for them. The body is returned so a caller can see `is_active` and `is_visible` are now false.\n\nRequires scope: platform:billing:write" } }, { "name": "List orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "List roadmap items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roadmap-items", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roadmap-items" ] }, "description": "Requires scope: platform:content:read" } }, { "name": "Create a roadmap item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roadmap-items", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roadmap-items" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "Get the roadmap item", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roadmap-items/{item}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roadmap-items", "{item}" ] }, "description": "Requires scope: platform:content:read" } }, { "name": "Update the roadmap item", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roadmap-items/{item}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roadmap-items", "{item}" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "Delete the roadmap item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roadmap-items/{item}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roadmap-items", "{item}" ] }, "description": "Requires scope: platform:content:write" } }, { "name": "List roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles" ] }, "description": "Requires scope: platform:users:read" } }, { "name": "Create a role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles" ] }, "description": "Gated on `platform:users:write`, not a scope of its own: a credential that can edit roles can grant itself, in effect, anything a user can do.\n\nPermissions are ATTACHED, never created — the permission list is defined by the code that checks it, and inventing a new string here would produce a role granting something nothing will ever ask about. A `tenant_id` makes this a tournament role rather than a platform one.\n\nRequires scope: platform:users:write" } }, { "name": "Get the role", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles/{role}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles", "{role}" ] }, "description": "Requires scope: platform:users:read" } }, { "name": "Update the role", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles/{role}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles", "{role}" ] }, "description": "Requires scope: platform:users:write" } }, { "name": "Delete the role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles/{role}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles", "{role}" ] }, "description": "Requires scope: platform:users:write" } }, { "name": "List tournaments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/tournaments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "tournaments" ] }, "description": "Requires scope: platform:tournaments:read" } }, { "name": "Create a tournament", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/tournaments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "tournaments" ] }, "description": "Goes through the signup funnel's own path, so the tournament arrives with its owner role, its setup-progress rows and its smart-defaulted settings.\n\nRequires scope: platform:tournaments:write" } }, { "name": "Get the tournament", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/tournaments/{{tournament}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "tournaments", "{{tournament}}" ] }, "description": "Requires scope: platform:tournaments:read" } }, { "name": "Update the tournament", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/tournaments/{{tournament}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "tournaments", "{{tournament}}" ] }, "description": "Requires scope: platform:tournaments:write" } }, { "name": "Delete the tournament", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/tournaments/{{tournament}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "tournaments", "{{tournament}}" ] }, "description": "Requires scope: platform:tournaments:write" } }, { "name": "Restore the tournament", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/tournaments/{{tournament}}/restore", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "tournaments", "{{tournament}}", "restore" ] }, "description": "Requires scope: platform:tournaments:write" } }, { "name": "List transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "transactions" ] }, "description": "Requires scope: platform:billing:read" } }, { "name": "List users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users" ] }, "description": "Requires scope: platform:users:read" } }, { "name": "Create a user account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users" ] }, "description": "Goes through UserService, which hashes the password (or generates one nobody knows when none is given), records the signup and fires `Registered` so verification mail goes out. Omitting `password` and leaving `send_invitation` true is the intended path for an account somebody else is creating.\n\nRequires scope: platform:users:write" } }, { "name": "Get the user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/{user}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", "{user}" ] }, "description": "Requires scope: platform:users:read" } }, { "name": "Update the user", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/{user}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", "{user}" ] }, "description": "Requires scope: platform:users:write" } }, { "name": "Soft-delete a user account", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/{user}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", "{user}" ] }, "description": "Refused with `409 user_has_tournaments` while the user still administers a tournament, because removing them can leave a live tournament with nobody able to administer it. The delete is soft: orders and invoices must outlive the account for accounting reasons.\n\nRequires scope: platform:users:write" } } ] } ] }