Club API
Version 1. Your club's website server can show the club's tournaments and send player sign-ups to the club. This page lists every call, field and error, and what the API cannot do.
What it is for
A poker club runs its tournaments in LynxPoker. With a club API key, the club's own website can show those tournaments and let players sign up for them there.
A sign-up from the website never seats the player and never takes a payment. It waits in LynxPoker until the club's staff seat the player or turn the sign-up down.
Before you start
- Only the club's owner can create a key, in the LynxPoker web app under Settings, then API keys. The owner picks a name and what the key may do. A club can have up to 20 active keys.
- A key needs a plan. A club on its free trial cannot create one. Any plan counts, however the club pays for it, and also a plan we gave the club. If the club's card payment fails, its keys keep working while the payment is tried again. Once the subscription is unpaid, or the plan ends, every call with its keys is refused with
403CLUB_API_NEEDS_PLAN. We keep the keys, and they work again on the next call once the club has a plan. - We show a key only once, when it is created. If it is lost, the owner revokes it and creates a new one. A revoked key stops working at once and cannot be turned back on.
- Call the API from your server only. The key is a secret: never put it in a web page, a mobile app or a public code repository. A call that carries a browser's
Originheader from your site is refused with403CLUB_API_BROWSER_BLOCKED. If your server passes a visitor's request on to us, do not copy the browser's headers.
Keys and answers
Every call goes to this address. The paths on this page start with /api.
https://api.lynx.pokerSend the key in the Authorization header of every call, after the word ClubKey and a space:
Authorization: ClubKey <keyId>.<secret>A key is two parts joined by a dot: the key ID and the secret. Send it exactly as you copied it.
What a key may do
The owner picks this when creating the key. A call that needs access the key does not have is refused with 403.
| Access | Name in the app | Calls |
|---|---|---|
TOURNAMENTS_READ | Read tournaments | GET /api/club-api/v1/tournaments GET /api/club-api/v1/tournaments/:id |
REGISTRATIONS_CREATE | Send sign-ups | POST /api/club-api/v1/tournaments/:id/registrations |
Answers
Every answer is JSON. A successful answer holds its data in body. Its status field always reads 200, so read the HTTP status instead: 200 for a read, 201 for a sign-up.
An error answer has the HTTP status, a message for people and, for most errors, an errorCode. Read the HTTP status and errorCode, never the message: messages can change.
HTTP/1.1 409 Conflict
{
"statusCode": 409,
"message": "Registration for this tournament is full.",
"errorCode": "APP_REG_CAP_FULL",
"details": { "limit": 40 },
"timestamp": "2026-11-10T09:30:00.000Z",
"path": "/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10/registrations"
}Calls
List the club's tournaments
GET/api/club-api/v1/tournaments
Access needed: TOURNAMENTS_READ
Returns the tournaments running or paused now, then the ones not started yet that are planned for the next 30 days. A tournament that has not started stays on the list for 6 hours after its planned start. The list holds at most 200: live ones first, then by planned start. A tournament not started yet is listed only when it has a planned start. Finished tournaments are never listed: read one by its ID.
Tournaments hidden from players and the club's practice tournament are never listed.
Each item is the summary the LynxPoker players app shows: the buy-in, the start, when late registration closes, and the field size and prize pool when the club shows them. serverTime is our clock, so you can correct for yours.
curl https://api.lynx.poker/api/club-api/v1/tournaments \
-H "Authorization: ClubKey $LYNX_CLUB_KEY"{
"status": 200,
"body": {
"items": [
{
"id": "b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10",
"organizationId": "5c2e9a71-0d3b-4f6a-8e14-2b7c9d0a1f33",
"timeFormat": "24h",
"dateFormat": "dmy",
"title": "Thursday deepstack",
"description": null,
"game": "Holdem",
"type": "Regular",
"format": "ReEntry",
"scheduledStartAt": "2026-11-12T18:00:00.000Z",
"startingTime": null,
"gameStatus": {
"position": "Created",
"currentLevelUuid": null,
"currentLevelStartTimestamp": null,
"unTouchedCurrentLevelStartTimestamp": null,
"currentLevelPauseStartTimestamp": null,
"startTimestamp": null,
"endTimestamp": null,
"tables": []
},
"settings": {
"buyIn": 800,
"rake": 150,
"bounty": null,
"startingStack": 30000,
"guarantee": 10000,
"reEntryLimit": 2,
"format": "ReEntry",
"isDisplayPrizes": true,
"isDisplayPotLimitBetRange": true,
"showReEntries": true,
"showTotalChips": true,
"showAddOns": false,
"showSeats": true,
"isAnnouncement": false,
"announcement": "",
"color": null
},
"info": {
"activePlayers": 0,
"aggregateEntries": 0,
"aggregateReEntries": 0,
"totalPrizePool": 0
},
"levelDurationMinutes": 20,
"lateRegLevel": 8,
"lateRegCloseAt": "2026-11-12T20:40:00.000Z",
"lateRegClosed": false
}
],
"serverTime": "2026-11-10T09:30:00.000Z"
}
}Errors this call can return: 401, 403, 429, 500, 503
Get one tournament
GET/api/club-api/v1/tournaments/:id
Access needed: TOURNAMENTS_READ
Returns one tournament of your club, in any state, also after it finishes. It has every field of a list item, plus the blind levels, the prizes, and the players when the club shows their names. It follows the club's settings for the players app, so it shows only what players see.
lateRegClosed is true once registration is closed: a sign-up then answers 409 APP_REG_CLOSED. appRegistrationEnabled is false when the players app takes no sign-ups for this tournament. That can be the club's choice for the players app only, or sign-ups turned off for this tournament, which refuses your sign-ups too with 403 APP_REG_DISABLED. appRegistrationLimit is the most sign-ups the tournament takes, from the players app and your website together, and null means no limit. No field promises that a sign-up will pass: the answer to the sign-up decides.
curl https://api.lynx.poker/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10 \
-H "Authorization: ClubKey $LYNX_CLUB_KEY"{
"status": 200,
"body": {
"id": "b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10",
"title": "Thursday deepstack",
"levels": [
{
"uuid": "0f4b2a6c-1e3d-4b5a-9c7e-2d8f6a4b1c3e",
"order": 1,
"orderWithBreaks": 1,
"in": 100,
"out": 200,
"ante": 200,
"lengthInMinuets": 20,
"isBreak": false
}
],
"prizes": [],
"lastUpdatedAt": "2026-11-09T16:12:44.000Z",
"serverTime": "2026-11-10T09:30:00.000Z",
"appRegistrationEnabled": true,
"appRegistrationLimit": 40
}
}Shortened: the real answer also has every field of a list item. <fields>Answer fields</fields> lists every field.
Errors this call can return: 401, 403, 404, 429, 500, 503
Send a sign-up
POST/api/club-api/v1/tournaments/:id/registrations
Access needed: REGISTRATIONS_CREATE
Asks to register one player for one tournament. Send the player's roster ID, or the player's name with a phone, an email or both. Never both ways in one call.
| Field | Type | Required | Rules |
|---|---|---|---|
playerId | string | Send this, or name | The ID of a player on your club's roster. At most 64 characters. |
name | string | Yes, without playerId | The player's name. Not blank, at most 120 characters. |
phone | string | A phone, an email or both, without playerId | At most 32 characters. See the phone rules below. |
email | string | A phone, an email or both, without playerId | A valid email address, at most 254 characters. |
Send only these fields: any other field is refused with 400. A field sent as null counts as not sent.
curl -X POST https://api.lynx.poker/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10/registrations \
-H "Authorization: ClubKey $LYNX_CLUB_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Jordan Example", "phone": "+1 702 555 0147", "email": "[email protected]"}'curl -X POST https://api.lynx.poker/api/club-api/v1/tournaments/b1f6c0e2-3a4d-4c8e-9f21-7d5a2c9e4b10/registrations \
-H "Authorization: ClubKey $LYNX_CLUB_KEY" \
-H "Content-Type: application/json" \
-d '{"playerId": "3e9a1c5b-2d4f-4a6b-8c0e-5f7a9b1d3c2e"}'The answer is 201 with the sign-up. Its status is always PENDING. createdPlayer is true when this call added the player to the club's roster.
HTTP/1.1 201 Created
{
"status": 200,
"body": {
"registrationId": "7d0c2f4e-8b1a-4e5f-a3c6-91b2d4e6f8a0",
"status": "PENDING",
"playerId": "3e9a1c5b-2d4f-4a6b-8c0e-5f7a9b1d3c2e",
"createdPlayer": true
}
}Errors this call can return: 400, 401, 403, 404, 409, 413, 429, 500, 503
How we find the player
With playerId, we use that player. It must be a player on your club's roster, or the answer is 404.
With a name, we look among your club's players for the same phone number or the same email. An email matches whatever its capital letters. The name is never used to find someone.
If several players match, we take the one with both the same phone and email, then the same phone, then the same email. Among equals, we take the one staff updated last.
If we find the player, we use them and change nothing in their details. If not, we add a new player to the club's roster with the name, phone and email you sent.
A phone number without + is read as a number in the club's country, or Israel when the club has none set. For a number from another country, start with + and the country code. A number that is not valid is refused with 400.
A placeholder number, one whose last 7 digits are all the same, such as 050-0000000, is refused with 400 unless you also send an email. Then we find the player by the email.
Sending the same sign-up again while it waits returns the same sign-up, with the same registrationId, and changes nothing. So you can safely retry a call that timed out. This holds only while registration is open: once it is closed, a repeat answers 409 APP_REG_CLOSED, and once sign-ups are off for the tournament, 403 APP_REG_DISABLED.
What happens next
The sign-up shows in the tournament's Registered players list in LynxPoker, marked From website, and staff get the same alert as for a sign-up from the players app. At the desk, staff seat the player or turn the sign-up down.
The API cannot tell your website what staff decided. No call reads a sign-up, and we send no webhooks. If the player uses the LynxPoker players app and is connected to the club, the app tells them when they are seated.
A repeat call is not a way to check. Once the player is seated or on the waiting list, a repeat answers 409 APP_REG_ALREADY_ENTERED. After staff turn a sign-up down, or once the player is out or removed, a repeat sends a new sign-up.
Answer fields
Every field our answers can carry, from the API's own definition. A field's meaning is given where its name does not say it.
Times are text in UTC, such as 2026-11-12T18:00:00.000Z. A field whose name ends in Timestamp is a number of milliseconds since 1 January 1970, UTC. Amounts of money are plain numbers with no currency.
A field marked "when it applies" is left out of the answer when it does not apply. null comes only in a field whose type has it.
list
The answer to the list call.
Where in the answer: body
| Field | Type | Sent | Meaning |
|---|---|---|---|
items | tournament[] | Always | |
serverTime | string (date-time) | Always | Our clock when we answered, so you can correct for yours. |
tournament
One tournament: each item of the list, and the start of the detail answer.
Where in the answer: body.items[] · body
| Field | Type | Sent | Meaning |
|---|---|---|---|
id | string | Always | The tournament's ID, for the detail and sign-up calls. |
organizationId | string | Always | Your club's ID. |
timeFormat | "12h" | "24h" | Always | How the club writes times: a 12-hour or a 24-hour clock. |
dateFormat | "dmy" | "mdy" | Always | How the club writes dates: day first (dmy) or month first (mdy). |
title | string | Always | |
description | string | null | Always | |
game | "Holdem" | "Omaha" | Always | |
type | "Regular" | "Mystery" | "Bounty" | "Progressive" | "Satellite" | Always | |
format | "ReEntry" | "Freezeout" | "Rebuy" | Always | |
scheduledStartAt | string (date-time) | null | Always | The planned start. null once play starts. |
startingTime | string (date-time) | null | Always | When play started. null before that. |
gameStatus | gameStatus | Always | |
settings | settings | Always | |
info | info | Always | |
levelDurationMinutes | number | null | Always | The length of the level being played, or of the first level before play starts. |
lateRegLevel | number | null | Always | The last level in which a player can still enter, counted from level 1. null when there is no late registration. |
lateRegCloseAt | string (date-time) | null | Always | When late registration closes, when a time applies. |
lateRegClosed | boolean | Always | true once registration is closed. A sign-up then answers 409 APP_REG_CLOSED. |
eventId | string | When it applies | The event this tournament is one day of. Sent only for a day of a multi-day event, with the next three fields. |
dayLabel | string | When it applies | The day's name as the club typed it, such as Day 1A or Day 2. |
dayKind | "FLIGHT" | "ONLINE" | "DAY" | When it applies | FLIGHT is a Day 1 flight, ONLINE a Day 1 whose entries staff type in, with no clock, and DAY is Day 2 or later. |
dayStep | number | When it applies | 1 for the Day 1 flights, 2 for Day 2, and so on. |
buyInPartWord | "RAKE" | "FEE" | "CUSTOM" | When it applies | The club's word for the house's part of the buy-in. Left out when it is RAKE. |
buyInPartCustom | string | When it applies | The club's own word for it, when buyInPartWord is CUSTOM. |
detail
The fields only the detail answer has, after those of a list item.
Where in the answer: body
| Field | Type | Sent | Meaning |
|---|---|---|---|
levels | level[] | Always | |
prizes | prize[] | Always | Empty unless the club shows prizes. |
players | player[] | When it applies | Sent only when the club shows player names. |
lastUpdatedAt | string (date-time) | Always | When the tournament last changed. |
serverTime | string (date-time) | Always | Our clock when we answered, so you can correct for yours. |
registeredCount | number | When it applies | Sign-ups that are waiting, seated or on the waiting list. Left out when the club hides player names. |
clockLayout | clockLayout | When it applies | |
clockStyle | "classic" | "dial" | When it applies | The club's clock style in the players app. A website can ignore it. |
clockValueOptions | clockValueOptions | When it applies | |
pendingRegistrationCount | number | When it applies | Sign-ups waiting for staff. Left out when the club hides the size of the field. |
appRegistrationEnabled | boolean | Always | Whether the players app takes sign-ups for this tournament now. See the detail call above for what false means for your sign-ups. |
appRegistrationLimit | number | null | Always | The most sign-ups the tournament takes, from the players app and your website together. null means no limit. |
structureEstimate | structureEstimate | null | When it applies | Sent only when the club turned it on, and only once late registration is closed. |
gameStatus
The state of the tournament's clock.
Where in the answer: gameStatus
| Field | Type | Sent | Meaning |
|---|---|---|---|
position | "Created" | "Running" | "Paused" | "Finished" | Always | Created: not started. Running or Paused: in play. Finished: over. |
currentLevelUuid | string | null | Always | The level being played, as the uuid of one of the levels. |
currentLevelStartTimestamp | number | null | Always | |
unTouchedCurrentLevelStartTimestamp | number | null | Always | |
currentLevelPauseStartTimestamp | number | null | Always | |
startTimestamp | number | null | Always | |
endTimestamp | number | null | Always | |
totalRunningTimeMs | number | When it applies | |
tables | number[] | Always | The numbers of the tables in play. Empty when the club does not show seats. |
handForHand | handForHand | When it applies | |
lastHands | lastHands | When it applies |
handForHand
Sent only while the tables play hand for hand, and the tournament is running or paused.
Where in the answer: gameStatus.handForHand
| Field | Type | Sent | Meaning |
|---|---|---|---|
on | boolean | Always | |
hand | number | Always |
lastHands
Sent only while the last hands are played, and the tournament is running or paused.
Where in the answer: gameStatus.lastHands
| Field | Type | Sent | Meaning |
|---|---|---|---|
total | number | Always | |
current | number | Always |
settings
The tournament's settings that players see.
Where in the answer: settings
| Field | Type | Sent | Meaning |
|---|---|---|---|
buyIn | number | Always | The full price of an entry. The rake and any bounty are inside it, never added to it. |
rake | number | Always | The house's part of buyIn. |
reEntryPrice | number | null | When it applies | The price of a re-entry or a rebuy, or null when there is none. |
bounty | number | null | Always | The bounty part of buyIn, or null when there is none. |
startingStack | number | Always | |
guarantee | number | null | Always | |
reEntryLimit | number | null | Always | |
format | "ReEntry" | "Freezeout" | "Rebuy" | Always | |
seatsPerTable | number | When it applies | |
isDisplayPrizes | boolean | Always | true when the club shows prizes. When false, prizes is empty and info has no pools. |
isDisplayPotLimitBetRange | boolean | Always | |
startingLevelUuid | string | null | When it applies | |
startingRemainingMs | number | null | When it applies | |
showReEntries | boolean | Always | |
showTotalChips | boolean | Always | |
showAddOns | boolean | Always | |
rebuyStackLimit | number | null | When it applies | |
addOn | addOn | null | When it applies | The add-on, or null when the tournament has none. |
showSeats | boolean | Always | false when the club does not show who sits where. Every player's table and seat are then null. |
isAnnouncement | boolean | Always | |
announcement | string | Always | |
color | string | null | Always | The clock colour the club picked, as a hex colour, or null. |
addOn
The add-on, while the tournament has one.
Where in the answer: settings.addOn
| Field | Type | Sent | Meaning |
|---|---|---|---|
afterLevel | number | Always | Sold at the break after this level. |
buyIn | number | Always | Its full price, with the rake inside it. |
stack | number | Always |
info
The field and the prize pool. The counts are left out when the club hides its players, and the pools when it hides prizes. The satellite fields are null on a tournament that is not a satellite.
Where in the answer: info
| Field | Type | Sent | Meaning |
|---|---|---|---|
bountyPool | number | When it applies | |
activePlayers | number | When it applies | |
aggregateEntries | number | When it applies | |
aggregateReEntries | number | When it applies | |
theoreticalTotalChips | number | When it applies | |
aggregateAddOns | number | When it applies | |
totalPrizePool | number | When it applies | |
satelliteSeats | number | null | When it applies | |
satelliteSeatMode | "GUARANTEED" | "AUTO" | null | When it applies | |
satelliteTargetStack | number | null | When it applies | |
satelliteQualified | number | null | When it applies | |
qualifiedStackTotal | number | null | When it applies |
level
One blind level or break, in playing order.
Where in the answer: levels[]
| Field | Type | Sent | Meaning |
|---|---|---|---|
lengthInMinuets | number | Always | The level's length in minutes. The field's name is spelled this way. |
in | number | Always | The small blind. |
out | number | Always | The big blind. |
ante | number | Always | |
isBreak | boolean | Always | |
order | number | Always | |
orderWithBreaks | number | Always | |
uuid | string | Always | The level's ID, as in gameStatus.currentLevelUuid. |
prize
One place in the prize list. The list is empty unless the club shows prizes.
Where in the answer: prizes[]
| Field | Type | Sent | Meaning |
|---|---|---|---|
place | number | Always | |
prizeAmount | number | null | Always | |
prizePercentage | number | Always | |
prizeType | "cash" | "seat" | When it applies | seat when the prize is a seat in another tournament. |
seatLabel | string | null | When it applies |
player
One player. Sent only when the club shows player names.
Where in the answer: players[]
| Field | Type | Sent | Meaning |
|---|---|---|---|
name | string | Always | |
entries | number | Always | |
busted | boolean | Always | true once the player is out. |
qualified | boolean | Always | true when the player won a seat in a satellite. |
chips | number | null | When it applies | The player's chips, or null when the club does not show chips. |
placed | number | null | When it applies | The player's finishing place, when the club shows places. |
placedTo | number | When it applies | The end of a shared place: placed 22 and placedTo 23 is 22nd to 23rd. |
payout | number | When it applies | The player's prize money. Sent only when the club shows places and prizes. |
knockouts | number | When it applies | |
rebuys | number | Always | |
addOns | number | Always | |
tableNumber | number | null | Always | null when the player has no seat, or the club does not show seats. |
seatNumber | number | null | Always | null when the player has no seat, or the club does not show seats. |
structureEstimate
Roughly when the tournament ends, as a range.
Where in the answer: structureEstimate
| Field | Type | Sent | Meaning |
|---|---|---|---|
loMin | number | Always | The early end of the range, in minutes from the start. |
hiMin | number | Always | The late end of the range, in minutes from the start. |
loAt | string (date-time) | null | Always | The early end as a time, when the start is known. |
hiAt | string (date-time) | null | Always | The late end as a time, when the start is known. |
clockLayout
How the club's clock screen looks in the players app, with the next three tables. A website can ignore them.
Where in the answer: clockLayout
| Field | Type | Sent | Meaning |
|---|---|---|---|
open | clockState | Always | |
closed | clockState | Always |
clockState
Part of the clock layout: the clock while registration is open, and once it is closed.
Where in the answer: clockLayout.open · clockLayout.closed
clockSide
Part of the clock layout: what one side of the clock shows.
Where in the answer: clockLayout.*.left · clockLayout.*.right
| Field | Type | Sent | Meaning |
|---|---|---|---|
mode | "list" | "thirds" | Always | |
values | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | When it applies | |
top | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | When it applies | |
middle | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | When it applies | |
bottom | ("level" | "startingStack" | "lateReg" | "reEntry" | "addOn" | "seats" | "totalTime" | "nextBreak" | "timeNow" | "estFinish" | "players" | "registered" | "tablesLeft" | "avgStack" | "totalChips" | "buyIn" | "prizePool" | "prizeList" | "bountyPool" | "reEntryPrice")[] | When it applies |
clockValueOptions
Part of the clock layout: how some values are written on the clock.
Where in the answer: clockValueOptions
| Field | Type | Sent | Meaning |
|---|---|---|---|
buyInSplit | boolean | Always | |
lateRegFormat | "level" | "time" | Always | |
prizeListMotion | "pages" | "bounce" | "loop" | Always | |
avgStackInBb | boolean | Always | |
startingStackInBb | boolean | Always |
registration
The answer to a sign-up.
Where in the answer: body
| Field | Type | Sent | Meaning |
|---|---|---|---|
registrationId | string | Always | The sign-up's ID. |
status | "PENDING" | Always | Always PENDING: the sign-up waits for staff. |
playerId | string | Always | The player's ID on your club's roster. Send it as playerId next time. |
createdPlayer | boolean | Always | true when this call added the player to the roster. |
What the API cannot do
Version 1 has none of these:
- List or search the club's players, or read anyone's phone or email. Answers carry no contact details.
- Add a player without a sign-up, or change a player's details.
- Read, cancel or change a sign-up after it is sent.
- Seat a player, take a payment or record a buy-in.
- Create or change a tournament, or change anything else in the club.
- Read the club's money: payments or takings. Prizes, the prize pool and each player's prize money show only as players see them, when the club shows them.
- Page through or filter the list of tournaments. It holds at most 200, with no next page.
- List finished or past tournaments. Read a finished one by its ID instead.
- See tournaments hidden from players, or the practice tournament.
- Be called from a browser page. A call that carries a browser's
Originheader from your site is refused. - Act for another club. A key reads and sends sign-ups for its own club only, and any other tournament answers
404. - Create, list or revoke keys. Only the owner does that, in the web app.
- Tell your server when something changes. There are no webhooks: read the list again when you need it.
Limits and errors
Each key can make 10 calls a second and 300 calls in 10 minutes, counting all three calls together, and send 200 new sign-ups in any 24 hours. A sign-up sent again after staff turned it down counts as new. Repeating a sign-up that still waits does not count toward the 200. On top of that, calls from one IP address are limited for each of the three calls: 30 a second, 150 in 10 seconds and 600 in a minute, whatever keys they use.
| Status | errorCode | What it means | What to do |
|---|---|---|---|
| 400 | None | The body is wrong: it is not valid JSON, a field is missing, empty, too long or not allowed, the email is not valid, both ways were sent, a name came with no phone or email, or the phone is not valid or is a placeholder. | Fix the request. The message says what is wrong. |
| 401 | None | The key is missing, not sent as ClubKey and a space before it, wrong or revoked. | Check the key. If it was revoked, ask the club's owner for a new one. |
| 403 | CLUB_API_NEEDS_PLAN | The club has no plan: it is on its free trial, its plan ended, or its subscription is unpaid. | Ask the club to pick a plan. The key works again once it does. |
| 403 | None | The key does not have the access this call needs. | Ask the owner for a key with that access. |
| 403 | CLUB_API_BROWSER_BLOCKED | The call carried a browser's Origin header from your site. Calls come from your server only. | Call from your server, without an Origin header. |
| 403 | APP_REG_DISABLED | Sign-ups are off for this tournament, or this player cannot sign up at this club. | Do not retry. Tell the player to contact the club. |
| 404 | None | The tournament is not one your key can see (another club's, hidden from players, the practice one, or no such ID), or the player is not on the club's roster. | Check the ID, and list the tournaments again. |
| 409 | APP_REG_CLOSED | Registration for this tournament is closed: late registration ended, staff closed registration, the last level ended while staff settle the results, or the tournament finished. | Do not retry. Stop offering sign-ups for this tournament. |
| 409 | APP_REG_CAP_FULL | The tournament reached its sign-up limit, which details.limit holds. | Do not retry unless a place frees up. |
| 409 | APP_REG_ALREADY_ENTERED | The player is already playing in this tournament. | Nothing: the player is in. |
| 409 | TOURNAMENT_BUSY | Someone saved this tournament at the same moment. Nothing was changed. | Try again in a moment. |
| 413 | PAYLOAD_TOO_LARGE | The body is over 100 kB. | Send only the fields on this page. |
| 429 | CLUB_KEY_DAILY_SIGNUP_LIMIT | The key sent 200 new sign-ups in the last 24 hours, the limit details.limit holds. | Wait the seconds in the Retry-After header, also in details.retryAfterSeconds: by then a sign-up has left the 24 hours. |
| 429 | None | Too many calls: over 10 a second or 300 in 10 minutes for this key, or over the limits for your IP address. Past 300 calls, the key is refused for up to 10 minutes. | Wait the seconds in the Retry-After header, then call less often. The IP address limits send Retry-After-short, Retry-After-medium or Retry-After-long instead. |
| 500 | INTERNAL_ERROR | Something failed on our side. | Try again after a short wait. Repeating a sign-up is safe. |
| 503 | DB_STATEMENT_TIMEOUT | Our database took too long to answer. Nothing was changed. | Try again after a short wait. |
Changes
This is version 1, named v1 in every path. We only add to it: new fields in answers, never a removed or renamed one. Ignore fields you do not know, so a new one never breaks your code.
Questions about the API? Contact us.