Разработчикам

Эндпоинты находятся под https://akilli.futbol/api/v1; запросы и ответы в формате JSON.

Весь справочник есть и в виде документа OpenAPI 3.1, который можно загрузить в Postman, Insomnia или генератор клиентов.

Описания и примечания к эндпоинтам берутся прямо из документа OpenAPI, поэтому они на английском.

118 эндпоинтов в 17 разделах.

1. 1

   Создай аккаунт или войди: отправь имя пользователя и пароль в виде JSON на POST /api/auth/sign-up/username или POST /api/auth/sign-in/username.

   curl -i -X POST https://akilli.futbol/api/auth/sign-in/username \
     -H "content-type: application/json" \
     -d '{"username": "deniz", "password": "kale-direği-1905"}'

2. 2

   Сохрани подписанный токен из заголовка ответа set-auth-token в надёжном месте на устройстве. Как bearer-токен работает только он: token в теле ответа — это необработанный токен сеанса, и он отклоняется.

   HTTP/1.1 200 OK
   set-auth-token: P4cTUK….9e7wV6…=
   content-type: application/json
   
   {
     "redirect": false,
     "token": "P4cTUK…",
     "user": { "id": "0193…", "username": "deniz", "name": "Deniz", … }
   }

3. 3

   Отправляй Authorization: Bearer <token> с каждым запросом.

   curl https://akilli.futbol/api/v1/me \
     -H "Authorization: Bearer P4cTUK….9e7wV6…="

В браузере работает и cookie веб-сеанса. Неверный пароль и несуществующее имя пользователя дают одинаковую ошибку (401); заблокированные аккаунты получают 403 BANNED_USER. Число попыток входа ограничено для каждого IP и каждого имени пользователя (429).

Чтобы выйти, отправь POST /api/auth/sign-out; чтобы выйти на всех других устройствах — POST /api/auth/revoke-other-sessions. Тело запроса не нужно ни там, ни там. Сеанс завершается, только если вызов вернул 200, поэтому проверяй статус. Смена пароля через POST /api/auth/change-password завершает все сеансы, включая текущий, и возвращает новый токен в set-auth-token: сохрани его вместо старого.

Успешные ответы содержат результат в data. Ошибки содержат в error код, понятное сообщение и, где это полезно, коды ошибок по полям (fields).

{
  "data": { … }
}

{
  "error": {
    "code": "INVALID",
    "message": "Some fields are invalid",
    "fields": { "name": "tooShort" }
  }
}

Коды ошибок

• 401UNAUTHENTICATEDНет сеанса или токен недействителен: войди снова.
• 403FORBIDDENУ тебя нет прав на это действие.
• 404NOT_FOUNDТакого нет или тебе это не видно.
• 409CONFLICTЗапрос противоречит текущему состоянию; причина в fields.
• 422INVALIDТело запроса или некоторые поля недействительны; в fields есть код для каждого поля.
• 429RATE_LIMITEDСлишком много запросов: подожди немного и попробуй ещё раз.
• 500INTERNALНа сервере что-то пошло не так: попробуй позже.

Неизвестный путь под /api/v1 тоже отвечает 404 NOT_FOUND в этом формате; на метод, которого у пути нет, приходит 405 с пустым телом.

Эндпоинты под /api/auth относятся к Better Auth: их ответы приходят без обёртки data, а ошибки содержат code и message.

• GET/api/v1/sign-up

  Whether new accounts can be made

  Сеанс не нужен

  The apps hide sign-up while this is false; the sign-up endpoints then answer 403 SIGN_UP_CLOSED.

  Показать поляСкрыть поля

  data в ответе

  • openbooleanобязательно

    false during the private beta: only sign-in

• POST/api/auth/sign-up/username

  Create an account and sign in

  Сеанс не нужен

  The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>. 403 SIGN_UP_CLOSED during the private beta (GET /api/v1/sign-up says whether sign-up is open). Rate-limited per IP: 20 per 10 minutes (429). 400 INVALID_SIGN_UP with an error code per field in errors: displayName: displayName; username: username (3–20 characters of a–z, 0–9 and _); password: password (12–128 characters), passwordIsUsername or passwordCommon; adult, privacyNotice, terms: required; form: generic (positions or locale not valid). 400 USERNAME_IS_ALREADY_TAKEN with errors.username = usernameTaken (reserved names count as taken). 400 VALIDATION_ERROR when a field is missing or has the wrong type. 403 for a sign-up a browser sends from another site.

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело запроса

  • displayNamestringобязательно

    2–40 characters

  • usernamestringобязательно

    3–20: a-z, 0-9, _ (stored lower-case)

  • passwordstringобязательно

    12–128 characters; not a common password, not built from the username or name

  • positionsstring[]необязательно

    Значения: "goalkeeper", "defender", "midfielder", "forward"

  • adultbooleanобязательно

    Значения: true

  • privacyNoticebooleanобязательно

    Значения: true

  • termsbooleanобязательно

    Значения: true

  • localestringобязательно

    Значения: "tr", "en", "ru", "ar"

  Тело ответа

  • userobjectобязательно
    • idstringобязательно
    • usernamestringобязательно
• POST/api/auth/sign-in/username

  Sign in

  Сеанс не нужен

  The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>. 401 INVALID_USERNAME_OR_PASSWORD for any wrong name or password; 403 BANNED_USER; 429 TOO_MANY_ATTEMPTS after repeated wrong passwords for the username, from any address, or 429 without a code past the per-IP limit (3 per 10 seconds).

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело запроса

  • usernamestringобязательно
  • passwordstringобязательно
  • rememberMebooleanнеобязательно

  Тело ответа

  • redirectbooleanобязательно

    Always false

  • tokenstringобязательно

    The raw session token. It is refused as a bearer token: use the set-auth-token header. The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>.

  • userobjectобязательно
    • idstringобязательно
    • usernamestringобязательно

      Lower-case; the profile address, /p/{username}

    • displayUsernamestringобязательно
    • namestringобязательно

      The display name

    • emailstringобязательно

      Not an address: a random placeholder Better Auth needs (accounts have no email). Ignore it

    • emailVerifiedbooleanобязательно
    • imagestring | nullобязательно
    • rolestring | nullобязательно

      "admin" or "user"

    • bannedboolean | nullобязательно
    • banReasonstring | nullобязательно
    • banExpiresstring | nullобязательно
    • createdAtstringобязательно
    • updatedAtstringобязательно
• POST/api/auth/sign-in/apple

  Sign in with Apple (and create the account on first use)

  Сеанс не нужен

  The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>. An Apple ID that already has an account signs in (403 BANNED_USER for a banned one). During the private beta a new Apple ID answers 403 SIGN_UP_CLOSED. Otherwise a new Apple ID answers 409 APPLE_SIGN_UP_REQUIRED with suggestion: { username, displayName } (from the email Apple shares, or the name; the email is never stored and never signs anyone in) until the call comes back with username, displayName, and adult, privacyNotice and terms true: then the account is made like sign-up's, with no password. Field errors as sign-up's: 400 INVALID_SIGN_UP with errors, 400 USERNAME_IS_ALREADY_TAKEN. 401 INVALID_APPLE_TOKEN when the token does not verify (signature, issuer, audience, expiry or nonce); 503 APPLE_UNAVAILABLE when Apple's keys cannot be fetched. Rate-limited per IP: 30 per 10 minutes.

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело запроса

  • identityTokenstringобязательно

    The identity token from Sign in with Apple on the device

  • noncestringобязательно

    The raw nonce the app made for this request; the token carries its SHA-256 hex

  • authorizationCodestringнеобязательно

    Lets the server revoke Apple's tokens when the account is deleted

  • givenNamestringнеобязательно

    Apple shares the name on the first authorization only: pass it on

  • familyNamestringнеобязательно
  • usernamestringнеобязательно

    For a new account: 3–20 a-z, 0-9, _ (start from suggestion.username)

  • displayNamestringнеобязательно

    For a new account: 2–40 characters (start from suggestion.displayName)

  • positionsstring[]необязательно

    Значения: "goalkeeper", "defender", "midfielder", "forward"

  • adultbooleanнеобязательно

    For a new account: true

  • privacyNoticebooleanнеобязательно

    For a new account: true

  • termsbooleanнеобязательно

    For a new account: true

  • localestringобязательно

    Значения: "tr", "en", "ru", "ar"

  Тело ответа

  • userobjectобязательно
    • idstringобязательно
    • usernamestringобязательно
  • createdbooleanобязательно

    true when this call made the account

• POST/api/auth/is-username-available

  Check whether a username is free

  Сеанс не нужен

  What the sign-up form asks as you type. Reserved names (staff words, the brand, app routes such as destek or developers) and names in use answer available: false, as sign-up would refuse them. 422 USERNAME_TOO_SHORT, USERNAME_TOO_LONG or INVALID_USERNAME (3–20 characters of a–z, 0–9 and _). Rate-limited per IP: 30 per minute (429).

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело запроса

  • usernamestringобязательно

    As typed: it is checked after the same normalising as sign-up (Turkish letters folded, lower-cased)

  Тело ответа

  • availablebooleanобязательно
• POST/api/auth/sign-out

  Sign out (ends this session)

  Нужен сеанс

  The session ends only when this answers 200 { success: true }; after any other answer the token may still work. Forget the stored token either way.

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело запроса

  Полей нет.

  Тело ответа

  • successbooleanобязательно
• GET/api/auth/get-session

  The current session and user

  Нужен сеанс

  Answers 200 with null, not 401, when there is no valid session.

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело ответа

  • sessionobjectобязательно
    • idstringобязательно
    • userIdstringобязательно
    • tokenstringобязательно

      The raw session token. It is refused as a bearer token: use the set-auth-token header. The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>.

    • expiresAtstringобязательно

      ISO 8601. A session lasts 7 days and is extended, at most once a day, while it is used

    • createdAtstringобязательно
    • updatedAtstringобязательно
    • ipAddressstring | nullобязательно
    • userAgentstring | nullобязательно
    • impersonatedBystring | nullобязательно
  • userobjectобязательно
    • idstringобязательно
    • usernamestringобязательно

      Lower-case; the profile address, /p/{username}

    • displayUsernamestringобязательно
    • namestringобязательно

      The display name

    • emailstringобязательно

      Not an address: a random placeholder Better Auth needs (accounts have no email). Ignore it

    • emailVerifiedbooleanобязательно
    • imagestring | nullобязательно
    • rolestring | nullобязательно

      "admin" or "user"

    • bannedboolean | nullобязательно
    • banReasonstring | nullобязательно
    • banExpiresstring | nullобязательно
    • createdAtstringобязательно
    • updatedAtstringобязательно
• POST/api/auth/change-password

  Change the password

  Нужен сеанс

  Signs every session out, this one included, and starts a new one: replace the stored token with the new set-auth-token response header (a browser gets a new cookie). Every other device has to sign in again. A revokeOtherSessions field is ignored. 400 INVALID_PASSWORD (the current password is wrong), PASSWORD_TOO_SHORT, PASSWORD_TOO_LONG, PASSWORD_IS_USERNAME or PASSWORD_TOO_COMMON (a common word or a password built from the username or name); 401 without a valid session.

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело запроса

  • currentPasswordstringобязательно
  • newPasswordstringобязательно

    12–128 characters; not the username, nothing common or built from the username or name

  Тело ответа

  • tokenstringобязательно

    The raw session token. It is refused as a bearer token: use the set-auth-token header. The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>.

  • userobjectобязательно
    • idstringобязательно
    • usernamestringобязательно

      Lower-case; the profile address, /p/{username}

    • displayUsernamestringобязательно
    • namestringобязательно

      The display name

    • emailstringобязательно

      Not an address: a random placeholder Better Auth needs (accounts have no email). Ignore it

    • emailVerifiedbooleanобязательно
    • imagestring | nullобязательно
    • rolestring | nullобязательно

      "admin" or "user"

    • bannedboolean | nullобязательно
    • banReasonstring | nullобязательно
    • banExpiresstring | nullобязательно
    • createdAtstringобязательно
    • updatedAtstringобязательно
• POST/api/auth/revoke-other-sessions

  Sign out every other device

  Нужен сеанс

  This device stays signed in. The other sessions end only when this answers 200 { status: true }; after any other answer they may still work, so try again.

  Эндпоинт Better Auth: ответ приходит без обёртки data.

  Показать поляСкрыть поля

  Тело запроса

  Полей нет.

  Тело ответа

  • statusbooleanобязательно

• GET/api/v1/me

  Your profile settings

  Нужен сеанс

  Показать поляСкрыть поля

  data в ответе

  • idstringобязательно

    The player id

  • userIdstringобязательно
  • usernamestringобязательно

    Fixed: the profile address, /p/{username}

  • handlestringобязательно
  • displayNamestringобязательно
  • positionsstring[]обязательно

    Значения: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullобязательно

    Your profile photo (PUT /api/v1/me/photo), or null

    • smallstringобязательно

      128 px

    • mediumstringобязательно

      512 px

    • largestringобязательно

      1024 px

  • visibilitystringобязательно

    Who sees your stats, teams and match history. public: everyone; teammates: people who share a team with you or a match you took part in; private: nobody else

    Значения: "public", "teammates", "private"

  • rolestring | nullобязательно

    "admin" or "user"

  • activeSessionsintegerобязательно

    Signed-in devices, this one included

  • appleLinkedbooleanобязательно

    Sign in with Apple opens this account (POST/DELETE /api/v1/me/apple)

  • hasPasswordbooleanобязательно

    The account has a password; an account made with Sign in with Apple has none

• PATCH/api/v1/me

  Change your display name, positions or visibility

  Нужен сеанс

  422 INVALID with fields.displayName = required | tooShort | tooLong | invalid, or fields.username = immutable when a different username is sent (the username never changes). Change the password at /api/auth/change-password; sign out other devices at /api/auth/revoke-other-sessions.

  Показать поляСкрыть поля

  Тело запроса

  • displayNamestringнеобязательно

    не меньше 1 символов

  • positionsstring[]необязательно

    Значения: "goalkeeper", "defender", "midfielder", "forward"

  • visibilitystringнеобязательно

    Значения: "public", "teammates", "private"

  data в ответе

  • idstringобязательно

    The player id

  • userIdstringобязательно
  • usernamestringобязательно

    Fixed: the profile address, /p/{username}

  • handlestringобязательно
  • displayNamestringобязательно
  • positionsstring[]обязательно

    Значения: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullобязательно

    Your profile photo (PUT /api/v1/me/photo), or null

    • smallstringобязательно

      128 px

    • mediumstringобязательно

      512 px

    • largestringобязательно

      1024 px

  • visibilitystringобязательно

    Who sees your stats, teams and match history. public: everyone; teammates: people who share a team with you or a match you took part in; private: nobody else

    Значения: "public", "teammates", "private"

  • rolestring | nullобязательно

    "admin" or "user"

  • activeSessionsintegerобязательно

    Signed-in devices, this one included

  • appleLinkedbooleanобязательно

    Sign in with Apple opens this account (POST/DELETE /api/v1/me/apple)

  • hasPasswordbooleanобязательно

    The account has a password; an account made with Sign in with Apple has none

• DELETE/api/v1/me

  Delete your account

  Нужен сеанс

  Signs out everywhere and deletes the login (password, Sign in with Apple, whose tokens are revoked), push devices, the photo and team memberships; the username is free again. Matches you played keep their scores and stats under the name "Silinmiş oyuncu" (Deleted player), with no profile. A team you captain passes to a co-captain or the longest-standing member; a team left empty is archived. Answers to coming matches become "no" and pending booking requests are withdrawn. Forget the stored token afterwards. 422 fields.confirm = mismatch.

  Показать поляСкрыть поля

  Тело запроса

  • confirmstringобязательно

    Your username, as a confirmation (any case)

  data в ответе

  • deletedbooleanобязательно

    Значения: true

• POST/api/v1/me/apple

  Link Sign in with Apple to your account

  Нужен сеанс

  From then on Sign in with Apple (POST /api/auth/sign-in/apple) opens this account. The email Apple may share is not stored. 401 UNAUTHENTICATED with fields.identityToken = invalid for a token that does not verify; 409 CONFLICT with fields.form = appleTaken (the Apple ID belongs to another account) or appleLinked (another Apple ID is linked).

  Показать поляСкрыть поля

  Тело запроса

  • identityTokenstringобязательно

    The identity token from Sign in with Apple on the device

  • noncestringобязательно

    The raw nonce the app made for this request; the token carries its SHA-256 hex

  • authorizationCodestringнеобязательно

    Lets the server revoke Apple's tokens when the account is deleted

  data в ответе

  • linkedbooleanобязательно

    Значения: true

• DELETE/api/v1/me/apple

  Unlink Sign in with Apple

  Нужен сеанс

  Apple's tokens are revoked. 409 CONFLICT with fields.form = lastSignInMethod when the account has no password (Apple is its only way in).

  Показать поляСкрыть поля

  data в ответе

  • linkedbooleanобязательно

    Значения: false

• POST/api/v1/me/devices

  Register this phone for pushes

  Нужен сеанс

  Send the APNs device token after sign-in and whenever iOS hands out a new one. The same token registered again refreshes it; signed in to another account on the phone, it moves to that account. Pushes so far: a match invitation (when you or one of your teams is invited), payload { "aps": { "alert": { "title", "body" }, "sound": "default", "category": "MATCH_INVITE", "thread-id": "match-<matchId>" }, "type": "matchInvite", "matchId", "teamName"? }, written in locale. The app's MATCH_INVITE category carries the buttons RSVP_YES, RSVP_MAYBE and RSVP_NO; answer with POST /api/v1/matches/{id}/rsvp. A person keeps their 10 most recently seen devices. 422 fields.token = invalid (not hex), fields.bundleId = unknown (not the Akıllı Futbol app). 429 after 30 registrations an hour.

  Показать поляСкрыть поля

  Тело запроса

  • tokenstringобязательно

    The APNs device token as hex (64 characters today)

  • platformstringобязательно

    Значения: "ios"

  • environmentstringобязательно

    sandbox for development builds (Xcode), production for TestFlight and the App Store

    Значения: "sandbox", "production"

  • bundleIdstringобязательно

    The app's bundle identifier

    1–200 символов

  • localestringобязательно

    The language pushes are written in

    Значения: "tr", "en", "ru", "ar"

  data в ответе

  • idstringобязательно

    The device id

  • tokenstringобязательно

    The token as stored: lower-case hex

• DELETE/api/v1/me/devices/{token}

  Stop pushes to one of your devices

  Нужен сеанс

  Call it at sign-out, before the session ends. Another person's token is left alone.

  Показать поляСкрыть поля

  Параметры пути

  • tokenstringобязательно

  data в ответе

  • removedbooleanобязательно

    False when the token was not registered to you

• GET/api/v1/me/photo

  Your profile photo

  Нужен сеанс

  Показать поляСкрыть поля

  data в ответе

  • photoobject | nullобязательно

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringобязательно

      128 px

    • mediumstringобязательно

      512 px

    • largestringобязательно

      1024 px

• PUT/api/v1/me/photo

  Upload or replace your profile photo

  Нужен сеанс

  Send the photo as the body (Content-Type: image/jpeg, image/png or image/webp), or as multipart/form-data with the file in the photo field. Up to 10 MB, at least 256 px on its shorter side. The server turns it upright by its EXIF orientation, cuts the largest centred square (crop it yourself first to choose), and stores WebP copies without any metadata: location, camera and time are dropped. The photo is seen by whoever may see your stats (your visibility), and never used to recognise anyone in match videos. 422 INVALID with fields.file = required | type | tooBig | dimensions.

  Показать поляСкрыть поля

  data в ответе

  • photoobject | nullобязательно

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringобязательно

      128 px

    • mediumstringобязательно

      512 px

    • largestringобязательно

      1024 px

• DELETE/api/v1/me/photo

  Remove your profile photo

  Нужен сеанс

  Your initials show again. Fine without a photo.

  Показать поляСкрыть поля

  data в ответе

  • photoobject | nullобязательно

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringобязательно

      128 px

    • mediumstringобязательно

      512 px

    • largestringобязательно

      1024 px

• GET/api/v1/teams

  Teams the caller plays for (archived teams left out)

  Нужен сеанс

  Показать поляСкрыть поля

  data в ответе

  Тип: object[]

  Поля каждого элемента:

  • idstring (uuid)обязательно
  • slugstringобязательно

    URL slug, e.g. kartallar-7k2m

  • namestringобязательно
  • citystring | nullобязательно
  • kitHomeHexstringобязательно

    #rrggbb, lower-case

  • kitAwayHexstring | nullобязательно

    #rrggbb, lower-case

  • crestobject | nullобязательно

    Custom crest, or null to use the team name and kit colours

    • shapestringобязательно

      Значения: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringобязательно
    • secondarystringобязательно
    • letterstringобязательно
    • patternstringнеобязательно

      Значения: "plain", "split", "stripes", "sash", "chevron", "hoops"По умолчанию: "plain"

    • detailstringнеобязательно

      Значения: "none", "star", "ball", "crown", "laurel", "wings"По умолчанию: "none"

  • rolestringобязательно

    The caller's role in the team

    Значения: "captain", "co_captain", "member"

  • memberCountintegerобязательно
• POST/api/v1/teams

  Start a team. The caller becomes captain and a 6-letter invite code is issued. Name and city are stored NFKC-normalised with single spaces. An optional crest has a shape, two distinct #rrggbb colours, one Unicode letter, a pattern (default plain) and a detail (default none). Field errors: name required/tooShort/tooLong/invalid (hidden or text-direction characters)/staffWord (reads as staff: “Akıllı Futbol”, “Admin”, “Destek”…), city tooLong/invalid, kitHomeHex required/invalid, kitAwayHex invalid/sameAsHome, crest.shape/primary/secondary/letter/pattern/detail invalid (equal colours: crest.secondary=differentColour).

  Нужен сеанс

  Показать поляСкрыть поля

  Тело запроса

  • namestringобязательно

    2–40 символов

  • citystring | nullнеобязательно

    не больше 60 символов

  • kitHomeHexstringобязательно
  • kitAwayHexstring | nullнеобязательно
  • crestobject | nullнеобязательно
    • shapestringобязательно

      Значения: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringобязательно
    • secondarystringобязательно
    • letterstringобязательно
    • patternstringнеобязательно

      Значения: "plain", "split", "stripes", "sash", "chevron", "hoops"По умолчанию: "plain"

    • detailstringнеобязательно

      Значения: "none", "star", "ball", "crown", "laurel", "wings"По умолчанию: "none"

  data в ответе

  • idstring (uuid)обязательно
  • slugstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • kitHomeHexstringобязательно

    #rrggbb, lower-case

  • kitAwayHexstring | nullобязательно

    #rrggbb, lower-case

  • crestobject | nullобязательно
    • shapestringобязательно

      Значения: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringобязательно
    • secondarystringобязательно
    • letterstringобязательно
    • patternstringнеобязательно

      Значения: "plain", "split", "stripes", "sash", "chevron", "hoops"По умолчанию: "plain"

    • detailstringнеобязательно

      Значения: "none", "star", "ball", "crown", "laurel", "wings"По умолчанию: "none"

  • archivedAtstring (date-time) | nullобязательно
  • createdAtstring (date-time)обязательно
  • memberCountintegerобязательно
  • viewerobjectобязательно
    • rolestring | nullобязательно

      Null for an admin who is not a member

      Значения: "captain", "co_captain", "member"

    • canEditbooleanобязательно
    • canRotateCodebooleanобязательно
    • canArchivebooleanобязательно
    • mustHandOverbooleanобязательно

      The caller is the last captain: leaving needs a new captain first

    • onlyMemberbooleanобязательно

      Leaving would archive the team

  • codestring | nullобязательно

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullобязательно

    The link to share (a short /j/<code> link that opens the join page)

  • membersobject[]обязательно

    Captains first, then co-captains, then players

    • playerIdstring (uuid)обязательно
    • displayNamestringобязательно
    • handlestring | nullобязательно

      Null for guests

    • kindstringобязательно

      Значения: "registered", "guest"

    • positionsstring[]обязательно

      Follows the member's visibility, as on their profile: empty when it is private, unless it is your own or you are an admin

      Значения: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullобязательно

      Follows the member's visibility, like the positions

      • smallstringобязательно

        128 px

      • mediumstringобязательно

        512 px

      • largestringобязательно

        1024 px

    • rolestringобязательно

      Значения: "captain", "co_captain", "member"

    • numberinteger | nullобязательно
    • joinedAtstring (date-time)обязательно
    • isViewerbooleanобязательно
    • canobjectобязательно
      • rolesstring[]обязательно

        Roles the caller may give this member

        Значения: "captain", "co_captain", "member"

      • removebooleanобязательно
  • matchesobjectобязательно

    Up to 5 each

    • upcomingobject[]обязательно
      • idstring (uuid)обязательно
      • startsAtstring (date-time)обязательно
      • statusstringобязательно

        Значения: "planned", "played", "cancelled"

      • titlestring | nullобязательно
      • venueobject | nullобязательно
        • namestringобязательно
        • verifiedbooleanобязательно
      • sidesobject[]обязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsinteger | nullобязательно
        • oursbooleanобязательно

          This team plays on this side

    • recentobject[]обязательно
      • idstring (uuid)обязательно
      • startsAtstring (date-time)обязательно
      • statusstringобязательно

        Значения: "planned", "played", "cancelled"

      • titlestring | nullобязательно
      • venueobject | nullобязательно
        • namestringобязательно
        • verifiedbooleanобязательно
      • sidesobject[]обязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsinteger | nullобязательно
        • oursbooleanобязательно

          This team plays on this side

• GET/api/v1/teams/{slug}

  A team: roster, the caller's permissions, the invite code and matches. 404 unless the caller is a member or an admin.

  Нужен сеанс

  Показать поляСкрыть поля

  Параметры пути

  • slugstringобязательно

  data в ответе

  • idstring (uuid)обязательно
  • slugstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • kitHomeHexstringобязательно

    #rrggbb, lower-case

  • kitAwayHexstring | nullобязательно

    #rrggbb, lower-case

  • crestobject | nullобязательно
    • shapestringобязательно

      Значения: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringобязательно
    • secondarystringобязательно
    • letterstringобязательно
    • patternstringнеобязательно

      Значения: "plain", "split", "stripes", "sash", "chevron", "hoops"По умолчанию: "plain"

    • detailstringнеобязательно

      Значения: "none", "star", "ball", "crown", "laurel", "wings"По умолчанию: "none"

  • archivedAtstring (date-time) | nullобязательно
  • createdAtstring (date-time)обязательно
  • memberCountintegerобязательно
  • viewerobjectобязательно
    • rolestring | nullобязательно

      Null for an admin who is not a member

      Значения: "captain", "co_captain", "member"

    • canEditbooleanобязательно
    • canRotateCodebooleanобязательно
    • canArchivebooleanобязательно
    • mustHandOverbooleanобязательно

      The caller is the last captain: leaving needs a new captain first

    • onlyMemberbooleanобязательно

      Leaving would archive the team

  • codestring | nullобязательно

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullобязательно

    The link to share (a short /j/<code> link that opens the join page)

  • membersobject[]обязательно

    Captains first, then co-captains, then players

    • playerIdstring (uuid)обязательно
    • displayNamestringобязательно
    • handlestring | nullобязательно

      Null for guests

    • kindstringобязательно

      Значения: "registered", "guest"

    • positionsstring[]обязательно

      Follows the member's visibility, as on their profile: empty when it is private, unless it is your own or you are an admin

      Значения: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullобязательно

      Follows the member's visibility, like the positions

      • smallstringобязательно

        128 px

      • mediumstringобязательно

        512 px

      • largestringобязательно

        1024 px

    • rolestringобязательно

      Значения: "captain", "co_captain", "member"

    • numberinteger | nullобязательно
    • joinedAtstring (date-time)обязательно
    • isViewerbooleanобязательно
    • canobjectобязательно
      • rolesstring[]обязательно

        Roles the caller may give this member

        Значения: "captain", "co_captain", "member"

      • removebooleanобязательно
  • matchesobjectобязательно

    Up to 5 each

    • upcomingobject[]обязательно
      • idstring (uuid)обязательно
      • startsAtstring (date-time)обязательно
      • statusstringобязательно

        Значения: "planned", "played", "cancelled"

      • titlestring | nullобязательно
      • venueobject | nullобязательно
        • namestringобязательно
        • verifiedbooleanобязательно
      • sidesobject[]обязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsinteger | nullобязательно
        • oursbooleanобязательно

          This team plays on this side

    • recentobject[]обязательно
      • idstring (uuid)обязательно
      • startsAtstring (date-time)обязательно
      • statusstringобязательно

        Значения: "planned", "played", "cancelled"

      • titlestring | nullобязательно
      • venueobject | nullобязательно
        • namestringобязательно
        • verifiedbooleanобязательно
      • sidesobject[]обязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsinteger | nullобязательно
        • oursbooleanобязательно

          This team plays on this side

• PATCH/api/v1/teams/{slug}

  Edit name, city, kits and crest (captains and co-captains). Only the top-level fields sent change; send the whole crest to replace it. Null clears city, kitAwayHex or crest. A crest has a shape, two distinct #rrggbb colours, one Unicode letter, a pattern (default plain) and a detail (default none). Crest errors use crest.shape/primary/secondary/letter/pattern/detail; equal colours give crest.secondary=differentColour. The slug never changes.

  Нужен сеанс

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  Показать поляСкрыть поля

  Параметры пути

  • slugstringобязательно

  Тело запроса

  • namestringнеобязательно

    2–40 символов

  • citystring | nullнеобязательно

    не больше 60 символов

  • kitHomeHexstringнеобязательно
  • kitAwayHexstring | nullнеобязательно
  • crestobject | nullнеобязательно
    • shapestringобязательно

      Значения: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringобязательно
    • secondarystringобязательно
    • letterstringобязательно
    • patternstringнеобязательно

      Значения: "plain", "split", "stripes", "sash", "chevron", "hoops"По умолчанию: "plain"

    • detailstringнеобязательно

      Значения: "none", "star", "ball", "crown", "laurel", "wings"По умолчанию: "none"

  data в ответе

  • idstring (uuid)обязательно
  • slugstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • kitHomeHexstringобязательно

    #rrggbb, lower-case

  • kitAwayHexstring | nullобязательно

    #rrggbb, lower-case

  • crestobject | nullобязательно
    • shapestringобязательно

      Значения: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringобязательно
    • secondarystringобязательно
    • letterstringобязательно
    • patternstringнеобязательно

      Значения: "plain", "split", "stripes", "sash", "chevron", "hoops"По умолчанию: "plain"

    • detailstringнеобязательно

      Значения: "none", "star", "ball", "crown", "laurel", "wings"По умолчанию: "none"

  • archivedAtstring (date-time) | nullобязательно
  • createdAtstring (date-time)обязательно
  • memberCountintegerобязательно
  • viewerobjectобязательно
    • rolestring | nullобязательно

      Null for an admin who is not a member

      Значения: "captain", "co_captain", "member"

    • canEditbooleanобязательно
    • canRotateCodebooleanобязательно
    • canArchivebooleanобязательно
    • mustHandOverbooleanобязательно

      The caller is the last captain: leaving needs a new captain first

    • onlyMemberbooleanобязательно

      Leaving would archive the team

  • codestring | nullобязательно

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullобязательно

    The link to share (a short /j/<code> link that opens the join page)

  • membersobject[]обязательно

    Captains first, then co-captains, then players

    • playerIdstring (uuid)обязательно
    • displayNamestringобязательно
    • handlestring | nullобязательно

      Null for guests

    • kindstringобязательно

      Значения: "registered", "guest"

    • positionsstring[]обязательно

      Follows the member's visibility, as on their profile: empty when it is private, unless it is your own or you are an admin

      Значения: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullобязательно

      Follows the member's visibility, like the positions

      • smallstringобязательно

        128 px

      • mediumstringобязательно

        512 px

      • largestringобязательно

        1024 px

    • rolestringобязательно

      Значения: "captain", "co_captain", "member"

    • numberinteger | nullобязательно
    • joinedAtstring (date-time)обязательно
    • isViewerbooleanобязательно
    • canobjectобязательно
      • rolesstring[]обязательно

        Roles the caller may give this member

        Значения: "captain", "co_captain", "member"

      • removebooleanобязательно
  • matchesobjectобязательно

    Up to 5 each

    • upcomingobject[]обязательно
      • idstring (uuid)обязательно
      • startsAtstring (date-time)обязательно
      • statusstringобязательно

        Значения: "planned", "played", "cancelled"

      • titlestring | nullобязательно
      • venueobject | nullобязательно
        • namestringобязательно
        • verifiedbooleanобязательно
      • sidesobject[]обязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsinteger | nullобязательно
        • oursbooleanобязательно

          This team plays on this side

    • recentobject[]обязательно
      • idstring (uuid)обязательно
      • startsAtstring (date-time)обязательно
      • statusstringобязательно

        Значения: "planned", "played", "cancelled"

      • titlestring | nullобязательно
      • venueobject | nullобязательно
        • namestringобязательно
        • verifiedbooleanобязательно
      • sidesobject[]обязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsinteger | nullобязательно
        • oursbooleanобязательно

          This team plays on this side

• POST/api/v1/teams/{slug}/code

  Replace the invite code (captains and co-captains); the old code stops working at once

  Нужен сеанс

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  Показать поляСкрыть поля

  Параметры пути

  • slugstringобязательно

  data в ответе

  • codestringобязательно
  • inviteUrlstring (uri)обязательно
• PATCH/api/v1/teams/{slug}/members/{playerId}

  Change a member's role. Captains and co-captains manage players and co-captains; only captains make or change captains (403 fields.form=captainOnly). The last captain cannot step down (409 fields.form=lastCaptain). A player who is not (or no longer) on the team: 404 fields.form=memberGone.

  Нужен сеанс

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  Показать поляСкрыть поля

  Параметры пути

  • slugstringобязательно
  • playerIdstringобязательно

  Тело запроса

  • rolestringобязательно

    Значения: "captain", "co_captain", "member"

  data в ответе

  • playerIdstring (uuid)обязательно
  • rolestringобязательно

    Значения: "captain", "co_captain", "member"

• DELETE/api/v1/teams/{slug}/members/{playerId}

  Remove a member (same rules as roles; 404 fields.form=memberGone when they are not on the team). Removing yourself is leaving.

  Нужен сеанс

  403 fields.form=managersOnly for members who are not captains or co-captains; 409 fields.form=archived once the team is archived.

  Показать поляСкрыть поля

  Параметры пути

  • slugstringобязательно
  • playerIdstringобязательно

  data в ответе

  • archivedbooleanобязательно
• POST/api/v1/teams/{slug}/leave

  Leave the team. The last captain must make someone else captain first (409 fields.form=handOver); the last member leaving archives the team.

  Нужен сеанс

  Показать поляСкрыть поля

  Параметры пути

  • slugstringобязательно

  data в ответе

  • archivedbooleanобязательно

    The team is archived after this

• POST/api/v1/teams/{slug}/archive

  Archive the team (captains only): it leaves everyone's list and its code stops working; matches and stats stay

  Нужен сеанс

  403 fields.form=captainOnly for co-captains and players.

  Показать поляСкрыть поля

  Параметры пути

  • slugstringобязательно

  data в ответе

  • archivedAtstring (date-time)обязательно

• GET/api/v1/join/{code}

  What a six-letter code opens: a team or a match

  Сеанс не нужен

  Codes are case-insensitive; dashes and spaces are ignored. Signed out, the preview has counts but no names. The code a match had when it was cancelled, and the code a team had when it was closed, keep opening the preview (state: cancelled, archived: true) so the link explains itself; codes replaced before that are revoked. 404 NOT_FOUND with fields.code: invalid (not six code letters), unknown or revoked (replaced by a newer code). 429 RATE_LIMITED after 20 wrong codes in 15 minutes (per account; signed out, per address, or in one count shared by every caller whose address cannot be trusted); malformed codes are not counted.

  Показать поляСкрыть поля

  Параметры пути

  • codestringобязательно

  data в ответе

  • kindstringобязательно

    Значения: "team", "match"

  • codestringобязательно

    The canonical code: six capital letters

  • teamobjectнеобязательно
    • idstringобязательно
    • slugstringобязательно
    • namestringобязательно
    • citystring | nullобязательно
    • kitHomeHexstringобязательно

      #rrggbb

    • kitAwayHexstring | nullобязательно
    • memberCountintegerобязательно
    • captainobject | nullобязательно

      Null when signed out

      • idstringобязательно
      • displayNamestringобязательно
      • handlestring | nullобязательно
      • photoobject | nullобязательно

        Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

        • smallstringобязательно

          128 px

        • mediumstringобязательно

          512 px

        • largestringобязательно

          1024 px

    • archivedbooleanобязательно

      Closed teams take no new members

  • viewerobjectобязательно
    • signedInbooleanобязательно
    • memberbooleanобязательно
    • rolestring | nullобязательно

      Значения: "captain", "co_captain", "member"

    • canJoinbooleanобязательно
  • matchobjectнеобязательно
    • idstringобязательно
    • kindstringобязательно

      Значения: "fixture", "pickup"

    • statusstringобязательно

      Значения: "planned", "played", "cancelled"

    • statestringобязательно

      Answers are taken while open: not cancelled, not played and no score in yet. Kick-off does not close a match, so people can still join one they played.

      Значения: "open", "cancelled", "finished"

    • titlestring | nullобязательно
    • startsAtstringобязательно

      ISO 8601

    • durationMinintegerобязательно
    • venueobject | nullобязательно
      • namestringобязательно
      • citystring | nullобязательно
      • districtstring | nullобязательно
      • addressstring | nullобязательно
      • verifiedbooleanобязательно
    • pitchobject | nullобязательно
      • namestringобязательно
      • indoorbooleanобязательно
    • sidesobject[]обязательно
      • sidestringобязательно

        Значения: "A", "B"

      • labelstringобязательно
      • goalsinteger | nullобязательно
      • teamobject | nullобязательно
        • slugstringобязательно
        • namestringобязательно
    • comingobjectобязательно

      Yes answers per side (none: no side yet) and the number of maybes

      • Aintegerобязательно
      • Bintegerобязательно
      • noneintegerобязательно
      • totalintegerобязательно
      • maybeintegerобязательно
    • playersobject[]обязательно

      Who said yes or maybe; empty when signed out

      • idstringобязательно
      • displayNamestringобязательно
      • sidestring | nullобязательно

        Значения: "A", "B"

      • rsvpstringобязательно

        Значения: "yes", "maybe"

      • youbooleanобязательно
      • photoobject | nullобязательно

        Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

        • smallstringобязательно

          128 px

        • mediumstringобязательно

          512 px

        • largestringобязательно

          1024 px

    • organizerobject | nullобязательно

      Null when signed out

      • displayNamestringобязательно
• POST/api/v1/join/{code}

  Use a code: join the team, or answer the match invitation

  Нужен сеанс

  A team code makes you a member (again is a no-op: alreadyMember); closed teams answer 409 with fields.team = archived. A match code records your answer and puts you on your team's side; cancelled matches and matches with a score answer 409 with fields.match = cancelled | finished. 404 NOT_FOUND with fields.code: invalid (not six code letters), unknown or revoked (replaced by a newer code). 429 RATE_LIMITED after 20 wrong codes in 15 minutes (per account; signed out, per address, or in one count shared by every caller whose address cannot be trusted); malformed codes are not counted.

  Показать поляСкрыть поля

  Параметры пути

  • codestringобязательно

  Тело запроса

  • rsvpstringнеобязательно

    Match codes only; defaults to yes. Ignored for team codes.

    Значения: "yes", "maybe", "no"

  data в ответе

  • kindstringобязательно

    Значения: "team", "match"

  • teamobjectнеобязательно
    • idstringобязательно
    • slugstringобязательно
    • namestringобязательно
  • rolestringнеобязательно

    Значения: "captain", "co_captain", "member"

  • alreadyMemberbooleanнеобязательно
  • matchobjectнеобязательно
    • idstringобязательно
  • participantobjectнеобязательно
    • rsvpstringобязательно

      Значения: "invited", "yes", "maybe", "no"

    • sidestring | nullобязательно

      The side of the person's team, when they are in one

      Значения: "A", "B"

    • respondedAtstring | nullобязательно

• GET/api/v1/matches

  My matches: upcoming (soonest first) and past (latest first)

  Нужен сеанс

  At most 60 upcoming matches and the 40 latest past ones, with no further pages yet.

  Показать поляСкрыть поля

  data в ответе

  • upcomingobject[]обязательно
    • idstringобязательно
    • titlestring | nullобязательно
    • kindstringобязательно

      Значения: "pickup", "fixture"

    • statusstringобязательно

      Значения: "planned", "played", "cancelled"

    • startsAtstringобязательно

      ISO 8601 (UTC)

    • durationMinnumberобязательно
    • scoreStatestringобязательно

      Значения: "none", "entered", "confirmed"

    • venueobject | nullобязательно
      • namestringобязательно
      • districtstring | nullобязательно
      • citystring | nullобязательно
      • addressstring | nullобязательно
      • verifiedbooleanобязательно
      • latitudenumber | nullобязательно

        WGS84, when the venue set its location (for directions); null otherwise

      • longitudenumber | nullобязательно

        WGS84, when the venue set its location (for directions); null otherwise

    • pitchobject | nullобязательно
      • namestringобязательно
    • sidesobjectобязательно
      • Aobjectобязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsnumber | nullобязательно

          Null until the score is entered

        • bibHexstring | nullобязательно
        • teamIdstring | nullобязательно
        • teamNamestring | nullобязательно
      • Bobjectобязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsnumber | nullобязательно

          Null until the score is entered

        • bibHexstring | nullобязательно
        • teamIdstring | nullобязательно
        • teamNamestring | nullобязательно
    • comingnumberобязательно

      How many said "yes"

    • meobjectобязательно
      • rsvpstring | nullобязательно

        Значения: "invited", "yes", "maybe", "no"

      • sidestring | nullобязательно

        Значения: "A", "B"

      • isOrganizerbooleanобязательно
    • canRespondbooleanобязательно
  • pastobject[]обязательно
    • idstringобязательно
    • titlestring | nullобязательно
    • kindstringобязательно

      Значения: "pickup", "fixture"

    • statusstringобязательно

      Значения: "planned", "played", "cancelled"

    • startsAtstringобязательно

      ISO 8601 (UTC)

    • durationMinnumberобязательно
    • scoreStatestringобязательно

      Значения: "none", "entered", "confirmed"

    • venueobject | nullобязательно
      • namestringобязательно
      • districtstring | nullобязательно
      • citystring | nullобязательно
      • addressstring | nullобязательно
      • verifiedbooleanобязательно
      • latitudenumber | nullобязательно

        WGS84, when the venue set its location (for directions); null otherwise

      • longitudenumber | nullобязательно

        WGS84, when the venue set its location (for directions); null otherwise

    • pitchobject | nullобязательно
      • namestringобязательно
    • sidesobjectобязательно
      • Aobjectобязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsnumber | nullобязательно

          Null until the score is entered

        • bibHexstring | nullобязательно
        • teamIdstring | nullобязательно
        • teamNamestring | nullобязательно
      • Bobjectобязательно
        • sidestringобязательно

          Значения: "A", "B"

        • labelstringобязательно
        • goalsnumber | nullобязательно

          Null until the score is entered

        • bibHexstring | nullобязательно
        • teamIdstring | nullобязательно
        • teamNamestring | nullобязательно
    • comingnumberобязательно

      How many said "yes"

    • meobjectобязательно
      • rsvpstring | nullобязательно

        Значения: "invited", "yes", "maybe", "no"

      • sidestring | nullобязательно

        Значения: "A", "B"

      • isOrganizerbooleanобязательно
    • canRespondbooleanобязательно
• POST/api/v1/matches

  Create a match

  Нужен сеанс

  You come ("yes") on side A, or on B when you belong to side B's team only. Teams playing a side and invited teams get every member invited, on their team's side. Set alreadyPlayed: true to record a past match; it stays planned with no score or attendance until PUT /api/v1/matches/{id}/score saves them and changes its status to played. The squad can still be completed and invited players can answer before that. 422 fields codes: required, invalid (also hidden or text-direction characters in the title, a side's label or the notes), staffWord (the title or a side's label reads as staff: “Akıllı Futbol”, “Admin”, “Destek”…), tooLong, notMember (a team you are not in), sameTeam, noOfficialCamera; date or startsAt = notEnded when an already-played match has not finished; reservationId = invalid (not your confirmed booking, or combined with alreadyPlayed), unavailable (it has a match, or its time passed) or mismatch (the venue, pitch, start or length you sent differ). 429 fields.form = tooManyMatches: 20 new matches a day per person.

  Показать поляСкрыть поля

  Тело запроса

  • titlestring | nullнеобязательно

    Up to 60 characters

  • kindstringнеобязательно

    pickup (default): sides picked among friends; fixture: two teams

    Значения: "pickup", "fixture"

  • datestringнеобязательно

    Kick-off date on an Istanbul clock, YYYY-MM-DD (with time)

  • timestringнеобязательно

    Kick-off on an Istanbul clock, HH:MM (with date)

  • startsAtstringнеобязательно

    Instead of date + time: an ISO 8601 instant with an offset

  • durationMinnumberнеобязательно

    Default 60

    Значения: 60, 90, 120

  • venueIdstring | nullнеобязательно
  • pitchIdstring | nullнеобязательно

    A pitch of the venue (sets the venue when venueId is left out)

  • recordingstringнеобязательно

    official only on a pitch with an official camera

    Значения: "upload", "official"

  • sidesobjectнеобязательно

    Default labels "Turuncular" and "Maviler"

    • Aobjectобязательно
      • labelstringобязательно

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullнеобязательно

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullнеобязательно

        The bib colour as #rrggbb, or null for no bibs

    • Bobjectобязательно
      • labelstringобязательно

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullнеобязательно

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullнеобязательно

        The bib colour as #rrggbb, or null for no bibs

  • invitedTeamIdsstring[]необязательно

    Your teams whose members all get an invitation

  • notesstring | nullнеобязательно

    Up to 500 characters

  • alreadyPlayedbooleanнеобязательно

    Default false. True requires kick-off plus duration to have passed. The match stays planned until score and attendance are saved separately. Cannot be combined with reservationId.

  • reservationIdstringнеобязательно

    One of your confirmed bookings (GET /api/v1/reservations) that has no match yet: the match takes its venue, pitch, start and length and is linked to it (ADR-005)

  data в ответе

  • idstringобязательно
  • codestringобязательно
  • inviteUrlstring (uri)обязательно

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page.

• GET/api/v1/matches/{id}

  A match with its sides, people, place and code

  Нужен сеанс

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  data в ответе

  • idstringобязательно
  • titlestring | nullобязательно
  • kindstringобязательно

    Значения: "pickup", "fixture"

  • statusstringобязательно

    Значения: "planned", "played", "cancelled"

  • startsAtstringобязательно
  • endsAtstringобязательно
  • durationMinnumberобязательно
  • recordingstringобязательно

    Значения: "upload", "official"

  • scoreStatestringобязательно

    Значения: "none", "entered", "confirmed"

  • notesstring | nullобязательно
  • cancelledAtstring | nullобязательно
  • organizerobjectобязательно
    • playerIdstringобязательно
    • displayNamestringобязательно
    • handlestring | nullобязательно
  • venueobject | nullобязательно
    • idstringобязательно
    • namestringобязательно
    • citystring | nullобязательно
    • districtstring | nullобязательно
    • addressstring | nullобязательно
    • verifiedbooleanобязательно
    • slugstring | nullобязательно

      The venue's public booking page is /venues/<slug> while its pitch admin login is on; null otherwise

    • latitudenumber | nullобязательно

      WGS84, when the venue set its location (for directions); null otherwise

    • longitudenumber | nullобязательно

      WGS84, when the venue set its location (for directions); null otherwise

  • pitchobject | nullобязательно
    • idstringобязательно
    • namestringобязательно
    • indoorbooleanобязательно
    • officialCamerabooleanобязательно
  • cameraobject | nullобязательно

    Set when the match waits for the pitch's official camera

    • idstringобязательно
    • labelstringобязательно
    • officialbooleanобязательно
  • sidesobjectобязательно
    • Aobjectобязательно
      • sidestringобязательно

        Значения: "A", "B"

      • labelstringобязательно
      • goalsnumber | nullобязательно

        Null until the score is entered

      • bibHexstring | nullобязательно
      • teamIdstring | nullобязательно
      • teamNamestring | nullобязательно
    • Bobjectобязательно
      • sidestringобязательно

        Значения: "A", "B"

      • labelstringобязательно
      • goalsnumber | nullобязательно

        Null until the score is entered

      • bibHexstring | nullобязательно
      • teamIdstring | nullобязательно
      • teamNamestring | nullобязательно
  • participantsobject[]обязательно
    • playerIdstringобязательно
    • displayNamestringобязательно
    • handlestring | nullобязательно

      Null for guests

    • kindstringобязательно

      Значения: "registered", "guest"

    • sidestring | nullобязательно

      Значения: "A", "B"

    • rsvpstringобязательно

      Значения: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullобязательно
    • attendedbooleanобязательно
    • isOrganizerbooleanобязательно
    • positionsstring[]обязательно

      Where the person likes to play, as on their profile; empty when they gave none or their visibility hides it from you, and for guests

      Значения: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullобязательно

      Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

      • smallstringобязательно

        128 px

      • mediumstringобязательно

        512 px

      • largestringобязательно

        1024 px

  • teamsobject[]обязательно
    • teamIdstringобязательно
    • namestringобязательно
    • sidestring | nullобязательно

      Значения: "A", "B"

    • membersnumberобязательно
  • codestring | nullобязательно

    The live 6-letter join code; null once the match is cancelled

  • inviteUrlstring (uri) | nullобязательно

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page. Null with the code

  • hasVideobooleanобязательно
  • kickedOffbooleanобязательно
  • endedbooleanобязательно

    Kick-off plus the duration has passed

  • viewerobjectобязательно
    • playerIdstringобязательно

      Your player id, to find yourself in participants

    • canManagebooleanобязательно
    • isOrganizerbooleanобязательно
    • isAdminbooleanобязательно
    • rsvpstring | nullобязательно

      Значения: "invited", "yes", "maybe", "no"

    • sidestring | nullобязательно

      Значения: "A", "B"

    • canRespondbooleanобязательно
• PATCH/api/v1/matches/{id}

  Change a match (managers)

  Нужен сеанс

  Answers are kept. A team newly set on a side gets its members invited there, and a team moved to the other side takes its people along. Once the score is in, the details can still be corrected but a side's team cannot change (409 fields.form = scored). A match with a booking at its venue moves the booking with it: 409 fields.form = bookingSlotTaken when the new time or pitch is not free on the venue's grid, bookingVenue when the match would leave the booking's venue (cancel the booking first). Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  Тело запроса

  • titlestring | nullнеобязательно

    Up to 60 characters

  • kindstringнеобязательно

    pickup (default): sides picked among friends; fixture: two teams

    Значения: "pickup", "fixture"

  • datestringнеобязательно

    Kick-off date on an Istanbul clock, YYYY-MM-DD (with time)

  • timestringнеобязательно

    Kick-off on an Istanbul clock, HH:MM (with date)

  • startsAtstringнеобязательно

    Instead of date + time: an ISO 8601 instant with an offset

  • durationMinnumberнеобязательно

    Default 60

    Значения: 60, 90, 120

  • venueIdstring | nullнеобязательно
  • pitchIdstring | nullнеобязательно

    A pitch of the venue (sets the venue when venueId is left out)

  • recordingstringнеобязательно

    official only on a pitch with an official camera

    Значения: "upload", "official"

  • notesstring | nullнеобязательно

    Up to 500 characters

  • sidesobjectнеобязательно

    Only the fields you send change; a newly set team gets its members invited

    • Aobjectнеобязательно
      • labelstringнеобязательно

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullнеобязательно

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullнеобязательно

        The bib colour as #rrggbb, or null for no bibs

    • Bobjectнеобязательно
      • labelstringнеобязательно

        1–30 characters, e.g. "Turuncular"

      • teamIdstring | nullнеобязательно

        One of your teams playing this side; its members are invited on this side

      • bibHexstring | nullнеобязательно

        The bib colour as #rrggbb, or null for no bibs

  data в ответе

  • idstringобязательно
  • titlestring | nullобязательно
  • kindstringобязательно

    Значения: "pickup", "fixture"

  • statusstringобязательно

    Значения: "planned", "played", "cancelled"

  • startsAtstringобязательно
  • endsAtstringобязательно
  • durationMinnumberобязательно
  • recordingstringобязательно

    Значения: "upload", "official"

  • scoreStatestringобязательно

    Значения: "none", "entered", "confirmed"

  • notesstring | nullобязательно
  • cancelledAtstring | nullобязательно
  • organizerobjectобязательно
    • playerIdstringобязательно
    • displayNamestringобязательно
    • handlestring | nullобязательно
  • venueobject | nullобязательно
    • idstringобязательно
    • namestringобязательно
    • citystring | nullобязательно
    • districtstring | nullобязательно
    • addressstring | nullобязательно
    • verifiedbooleanобязательно
    • slugstring | nullобязательно

      The venue's public booking page is /venues/<slug> while its pitch admin login is on; null otherwise

    • latitudenumber | nullобязательно

      WGS84, when the venue set its location (for directions); null otherwise

    • longitudenumber | nullобязательно

      WGS84, when the venue set its location (for directions); null otherwise

  • pitchobject | nullобязательно
    • idstringобязательно
    • namestringобязательно
    • indoorbooleanобязательно
    • officialCamerabooleanобязательно
  • cameraobject | nullобязательно

    Set when the match waits for the pitch's official camera

    • idstringобязательно
    • labelstringобязательно
    • officialbooleanобязательно
  • sidesobjectобязательно
    • Aobjectобязательно
      • sidestringобязательно

        Значения: "A", "B"

      • labelstringобязательно
      • goalsnumber | nullобязательно

        Null until the score is entered

      • bibHexstring | nullобязательно
      • teamIdstring | nullобязательно
      • teamNamestring | nullобязательно
    • Bobjectобязательно
      • sidestringобязательно

        Значения: "A", "B"

      • labelstringобязательно
      • goalsnumber | nullобязательно

        Null until the score is entered

      • bibHexstring | nullобязательно
      • teamIdstring | nullобязательно
      • teamNamestring | nullобязательно
  • participantsobject[]обязательно
    • playerIdstringобязательно
    • displayNamestringобязательно
    • handlestring | nullобязательно

      Null for guests

    • kindstringобязательно

      Значения: "registered", "guest"

    • sidestring | nullобязательно

      Значения: "A", "B"

    • rsvpstringобязательно

      Значения: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullобязательно
    • attendedbooleanобязательно
    • isOrganizerbooleanобязательно
    • positionsstring[]обязательно

      Where the person likes to play, as on their profile; empty when they gave none or their visibility hides it from you, and for guests

      Значения: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullобязательно

      Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

      • smallstringобязательно

        128 px

      • mediumstringобязательно

        512 px

      • largestringобязательно

        1024 px

  • teamsobject[]обязательно
    • teamIdstringобязательно
    • namestringобязательно
    • sidestring | nullобязательно

      Значения: "A", "B"

    • membersnumberобязательно
  • codestring | nullобязательно

    The live 6-letter join code; null once the match is cancelled

  • inviteUrlstring (uri) | nullобязательно

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page. Null with the code

  • hasVideobooleanобязательно
  • kickedOffbooleanобязательно
  • endedbooleanобязательно

    Kick-off plus the duration has passed

  • viewerobjectобязательно
    • playerIdstringобязательно

      Your player id, to find yourself in participants

    • canManagebooleanобязательно
    • isOrganizerbooleanобязательно
    • isAdminbooleanобязательно
    • rsvpstring | nullобязательно

      Значения: "invited", "yes", "maybe", "no"

    • sidestring | nullобязательно

      Значения: "A", "B"

    • canRespondbooleanобязательно
• POST/api/v1/matches/{id}/cancel

  Cancel a match (managers)

  Нужен сеанс

  The code stops working, and the bookings linked to the match that have not started are cancelled with it (their answer reads @matchCancelled). 409 fields.form = scored once the score is in. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  data в ответе

  • idstringобязательно
  • statusstringобязательно

    Значения: "cancelled"

• POST/api/v1/matches/{id}/code

  Renew the match's join code (managers)

  Нужен сеанс

  The old code stops working at once; share the new one again. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  data в ответе

  • codestringобязательно

    6 letters A–Z without I and O

  • inviteUrlstring (uri)обязательно

    The link to share for the code, as for teams: a short /j/<code> link that opens the join page.

• POST/api/v1/matches/{id}/rsvp

  Answer an invitation

  Нужен сеанс

  For invited people and members of invited teams (who join on their team's side). 409 fields.form = cancelled or scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  Тело запроса

  • answerstringобязательно

    Значения: "yes", "maybe", "no"

  data в ответе

  • rsvpstringобязательно

    Значения: "invited", "yes", "maybe", "no"

  • sidestring | nullобязательно

    Значения: "A", "B"

• POST/api/v1/matches/{id}/teams

  Invite one of your teams (managers)

  Нужен сеанс

  Every member not yet in the match is invited. A team playing a side is invited on that side (422 fields.side = teamPlaysSide for the other one); otherwise members without a side, or still on the team's earlier side, take side. 422 fields.teamId = notMember for a team you are not in. Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  Тело запроса

  • teamIdstringобязательно
  • sidestring | nullнеобязательно

    Значения: "A", "B"

  data в ответе

  • invitednumberобязательно
  • membersnumberобязательно
• POST/api/v1/matches/{id}/participants

  Invite a person by username, or add a guest by name (managers)

  Нужен сеанс

  A guest is a player without an account, counted as coming; the name follows the same rules as a display name (422 fields.guestName = required, tooShort, tooLong or invalid). 422 fields.username = notFound; 409 fields.username = already. Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  Тело запроса

  • usernamestringнеобязательно
  • sidestring | nullнеобязательно

    Значения: "A", "B"

  • guestNamestringнеобязательно

    2–40 characters

  data в ответе

  • playerIdstringобязательно
  • displayNamestringобязательно
  • handlestring | nullобязательно

    Null for guests

  • kindstringобязательно

    Значения: "registered", "guest"

  • sidestring | nullобязательно

    Значения: "A", "B"

  • rsvpstringобязательно

    Значения: "invited", "yes", "maybe", "no"

  • respondedAtstring | nullобязательно
  • attendedbooleanобязательно
  • isOrganizerbooleanобязательно
  • positionsstring[]обязательно

    Where the person likes to play, as on their profile; empty when they gave none or their visibility hides it from you, and for guests

    Значения: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullобязательно

    Square WebP copies of the player's profile photo: paths on this host (GET /api/v1/photos/{id}). Present only when you may see the player (their visibility, as for their stats); null shows their initials instead

    • smallstringобязательно

      128 px

    • mediumstringобязательно

      512 px

    • largestringобязательно

      1024 px

• PATCH/api/v1/matches/{id}/participants/{playerId}

  Move a player to a side, or answer for a guest (managers)

  Нужен сеанс

  403 when rsvp is sent for a registered player (people answer for themselves); 422 fields.rsvp = invalid for any other value. Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно
  • playerIdstringобязательно

  Тело запроса

  • sidestring | nullнеобязательно

    Значения: "A", "B"

  • rsvpstringнеобязательно

    Guests only

    Значения: "yes", "maybe", "no"

  data в ответе

  • playerIdstringобязательно
  • sidestring | nullобязательно

    Значения: "A", "B"

  • rsvpstringобязательно

    Значения: "invited", "yes", "maybe", "no"

• DELETE/api/v1/matches/{id}/participants/{playerId}

  Take a player off the match (managers)

  Нужен сеанс

  409 fields.form = organizer (the organiser stays). Once the score is in, who played and on which side is changed with the score: 409 fields.form = scored. Errors: 401 signed out; 404 the match does not exist or you are not part of it; 403 you may see it but not change it (organiser, side captains and admins manage); 409 fields.form = cancelled once cancelled; 422 with fields.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно
  • playerIdstringобязательно

  data в ответе

  • playerIdstringобязательно
  • removedbooleanобязательно

    Значения: true

• GET/api/v1/venues

  Search venues

  Нужен сеанс

  Verified venues first, then by name; at most 12. An empty q lists venues the same way.

  Показать поляСкрыть поля

  Параметры запроса

  • qstringнеобязательно

    Words that must all appear in the name, district or city; Turkish letters optional ("kadikoy" finds "Kadıköy")

  data в ответе

  Тип: object[]

  Поля каждого элемента:

  • idstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • districtstring | nullобязательно
  • addressstring | nullобязательно
  • verifiedbooleanобязательно

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]обязательно
    • idstringобязательно
    • namestringобязательно

      e.g. "1. Saha"

    • indoorbooleanобязательно
    • officialCamerabooleanобязательно

      The pitch has the venue's own recorder: a match here can wait for its recording

• POST/api/v1/venues

  Add a venue

  Нужен сеанс

  New venues are unverified until an admin checks them. When a venue with the same name, city and district is already listed (ignoring case and Turkish letters), that venue comes back instead of a copy. 422 with fields (required, tooShort, tooLong, invalid for hidden characters, staffWord when the name reads as staff: “Akıllı Futbol”, “Resmi”…). 429 RATE_LIMITED after 20 new venues in 24 hours (admins are not limited).

  Показать поляСкрыть поля

  Тело запроса

  • namestringобязательно

    2–80 characters

  • citystringобязательно

    2–40 characters

  • districtstring | nullнеобязательно

    Up to 40 characters

  • addressstring | nullнеобязательно

    Up to 160 characters

  • pitchNamestring | nullнеобязательно

    A first pitch, e.g. "1. Saha"

  • indoorbooleanнеобязательно

    Whether that first pitch is indoors

  data в ответе

  • idstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • districtstring | nullобязательно
  • addressstring | nullобязательно
  • verifiedbooleanобязательно

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]обязательно
    • idstringобязательно
    • namestringобязательно

      e.g. "1. Saha"

    • indoorbooleanобязательно
    • officialCamerabooleanобязательно

      The pitch has the venue's own recorder: a match here can wait for its recording

• GET/api/v1/venues/recent

  Venues of your latest matches, then venues you added (at most five)

  Нужен сеанс

  Показать поляСкрыть поля

  data в ответе

  Тип: object[]

  Поля каждого элемента:

  • idstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • districtstring | nullобязательно
  • addressstring | nullобязательно
  • verifiedbooleanобязательно

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]обязательно
    • idstringобязательно
    • namestringобязательно

      e.g. "1. Saha"

    • indoorbooleanобязательно
    • officialCamerabooleanобязательно

      The pitch has the venue's own recorder: a match here can wait for its recording

• GET/api/v1/venues/{id}

  A venue with its pitches

  Нужен сеанс

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  data в ответе

  • idstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • districtstring | nullобязательно
  • addressstring | nullобязательно
  • verifiedbooleanобязательно

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]обязательно
    • idstringобязательно
    • namestringобязательно

      e.g. "1. Saha"

    • indoorbooleanобязательно
    • officialCamerabooleanобязательно

      The pitch has the venue's own recorder: a match here can wait for its recording

• POST/api/v1/venues/{id}/pitches

  Add a pitch to a venue

  Нужен сеанс

  Admins, or the person who added the venue while it is unverified (403 otherwise). 409 fields.name = taken for a duplicate name.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  Тело запроса

  • namestringобязательно

    1–40 characters, unique within the venue

  • indoorbooleanнеобязательно

  data в ответе

  • idstringобязательно
  • namestringобязательно
  • citystring | nullобязательно
  • districtstring | nullобязательно
  • addressstring | nullобязательно
  • verifiedbooleanобязательно

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]обязательно
    • idstringобязательно
    • namestringобязательно

      e.g. "1. Saha"

    • indoorbooleanобязательно
    • officialCamerabooleanобязательно

      The pitch has the venue's own recorder: a match here can wait for its recording

• GET/api/v1/venues/{id}/logo/{version}

  A venue's logo

  Сеанс не нужен

  Public, no sign-in. Take the path from the venue's logo field rather than building it: the version names one picture for good, so the answer is cached for a year (Cache-Control: public, max-age=31536000, immutable). A replaced or removed logo's version answers 404 NOT_FOUND. A PNG, JPEG or WebP of at most 1024 pixels a side, its type read from the file's bytes when it was uploaded; sent with X-Content-Type-Options: nosniff, Content-Security-Policy: default-src 'none' and Cross-Origin-Resource-Policy: same-site.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно
  • versionstringобязательно

• GET/api/v1/venues/{id}/profile

  A venue's public page

  Сеанс не нужен

  Works signed out. 404 unless the venue has a login that is switched on (only those venues have a page).

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  data в ответе

  • idstringобязательно
  • slugstringобязательно

    The page's address: /venues/<slug>

  • namestringобязательно
  • verifiedbooleanобязательно

    Checked by an admin; show the verified mark

  • districtstring | nullобязательно
  • citystring | nullобязательно
  • addressstring | nullобязательно
  • descriptionstring | nullобязательно

    Plain text, line breaks kept

  • logostring | nullобязательно

    A path to the logo (immutable, cache it), or null

  • directionsobjectобязательно

    Driving directions: to the coordinates when known, else a search for the name and address

    • googlestring (uri)обязательно
    • applestring (uri)обязательно
  • whatsappobject | nullобязательно

    Only when the venue shows it

    • digitsstringобязательно

      International, without +

    • linkstring (uri)обязательно

      https://wa.me/<digits>

  • reservationsEnabledbooleanобязательно

    The venue takes requests in the app; otherwise point people to WhatsApp

  • autoConfirmbooleanобязательно

    Requests from people who already had a booking confirmed here are confirmed at once, while they hold fewer than 2 coming bookings and requests here

  • slotMinutesnumberобязательно

    Start times every 30 or 60 minutes from opening

    Значения: 30, 60

  • openingHoursobjectобязательно

    Istanbul clock; null: closed

    • monobject | nullобязательно
      • openstringобязательно

        "10:00"

      • closestringобязательно

        "01:00"; at or before open means after midnight

    • tueobject | nullобязательно
      • openstringобязательно

        "10:00"

      • closestringобязательно

        "01:00"; at or before open means after midnight

    • wedobject | nullобязательно
      • openstringобязательно

        "10:00"

      • closestringобязательно

        "01:00"; at or before open means after midnight

    • thuobject | nullобязательно
      • openstringобязательно

        "10:00"

      • closestringобязательно

        "01:00"; at or before open means after midnight

    • friobject | nullобязательно
      • openstringобязательно

        "10:00"

      • closestringобязательно

        "01:00"; at or before open means after midnight

    • satobject | nullобязательно
      • openstringобязательно

        "10:00"

      • closestringобязательно

        "01:00"; at or before open means after midnight

    • sunobject | nullобязательно
      • openstringобязательно

        "10:00"

      • closestringобязательно

        "01:00"; at or before open means after midnight

  • todaystringобязательно

    The venue day open now (YYYY-MM-DD): the first day to offer. A venue day is named by the date it opens: Friday 10:00–02:00 holds Saturday 01:00

  • pitchesobject[]обязательно
    • idstringобязательно
    • namestringобязательно
    • indoorbooleanобязательно
• GET/api/v1/venues/{id}/availability

  Free times on a venue day, per pitch

  Сеанс не нужен

  States only, never who or why: confirmed bookings and blocked time make a time taken; requests the venue has not answered make it requested (still askable). With a bearer token the lead time is the person's own. 422 fields.date = outOfRange.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  Параметры запроса

  • datestringнеобязательно

    The venue day, YYYY-MM-DD (default: the venue day open now); from yesterday up to 31 days ahead

  • durationMinstringнеобязательно

    60 (default), 90 or 120

  data в ответе

  • datestringобязательно
  • durationMinnumberобязательно
  • slotMinutesnumberобязательно
  • hoursobject | nullобязательно

    That venue day's hours; null when closed

    • openstringобязательно

      "10:00"

    • closestringобязательно

      "01:00"; at or before open means after midnight

  • leadMinutesnumberобязательно

    How long before its start a time can still be asked for: 150 minutes, or 30 for someone the venue confirms at once

  • pitchesobject[]обязательно
    • idstringобязательно
    • namestringобязательно
    • slotsobject[]обязательно
      • timestringобязательно

        Istanbul wall clock, "21:00"

      • datestringобязательно

        The calendar date the time falls on (the next date after midnight)

      • startsAtstringобязательно

        ISO 8601 (UTC)

      • nextDaybooleanобязательно

        After the venue day's midnight: show it as "Friday night 01:00 (Saturday 9 November)"

      • statestringобязательно

        requested: someone asked and the venue has not answered; it can still be asked for

        Значения: "free", "requested", "taken", "soon", "tooFar"

• POST/api/v1/venues/{id}/reservations

  Ask a venue for a booking

  Нужен сеанс

  The booking waits for the venue (pending) and lapses 2 hours before its start if not answered; it is confirmed at once where the venue auto-confirms and you already had a booking confirmed there. 404 for a venue without a page (no login, or switched off). 409 fields.form: bookingsOff (the venue takes no requests now; use its WhatsApp), alreadyAsked, tooManyOpen (2 requests already waiting at this venue); fields.time = taken. 422 fields: pitchId.invalid, teamId.notMember, phone.invalid, matchId (invalid, booked, otherTime, otherPlace), time (closed, offGrid, soon, tooFar). 429 RATE_LIMITED after 6 requests in an hour (refused requests do not count).

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  Тело запроса

  • pitchIdstringобязательно
  • datestringобязательно

    The venue day, YYYY-MM-DD

  • timestringобязательно

    One of that day's start times (a slot's time), HH:MM

  • durationMinnumberобязательно

    Значения: 60, 90, 120

  • teamIdstring | nullнеобязательно

    One of your teams: side A of the match made on confirmation

  • notestring | nullнеобязательно

    Up to 300 characters, for the venue

  • phonestring | nullнеобязательно

    Shared with this venue only and erased 30 days after the start (or when the booking is declined, cancelled or lapses). "0532 123 45 67", "+90…"

  • wantsMatchbooleanнеобязательно

    Default true: when the venue confirms, your match is made (this venue, pitch and time, your team on side A) and linked

  • matchIdstring | nullнеобязательно

    Instead: one of your own matches at exactly this time with no booking yet, to link

  data в ответе

  • idstringобязательно
  • venueobjectобязательно
    • idstringобязательно
    • namestringобязательно
    • verifiedbooleanобязательно
    • slugstring | nullобязательно

      Null once the venue's page is gone

  • pitchobjectобязательно
    • idstringобязательно
    • namestringобязательно
  • startsAtstringобязательно
  • endsAtstringобязательно
  • durationMinnumberобязательно
  • venueDatestringобязательно

    The venue day it belongs to

  • nextDaybooleanобязательно
  • statusstringобязательно

    lapsed: the venue did not answer by 2 hours before the start

    Значения: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullобязательно

    The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

  • cancelledBystring | nullобязательно

    Значения: "person", "venue"

  • teamobject | nullобязательно
    • idstringобязательно
    • namestringобязательно
  • matchobject | nullобязательно

    The match made from (or linked to) the booking, while it is not cancelled

    • idstringобязательно
  • wantsMatchbooleanобязательно
  • canCancelbooleanобязательно
  • canMakeMatchbooleanобязательно

    Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

• GET/api/v1/reservations

  Your bookings

  Нужен сеанс

  upcoming: coming bookings whatever their answer (until they start; a confirmed one until it ends), soonest first. past: those of the last 30 days, latest first.

  Показать поляСкрыть поля

  data в ответе

  • upcomingobject[]обязательно
    • idstringобязательно
    • venueobjectобязательно
      • idstringобязательно
      • namestringобязательно
      • verifiedbooleanобязательно
      • slugstring | nullобязательно

        Null once the venue's page is gone

    • pitchobjectобязательно
      • idstringобязательно
      • namestringобязательно
    • startsAtstringобязательно
    • endsAtstringобязательно
    • durationMinnumberобязательно
    • venueDatestringобязательно

      The venue day it belongs to

    • nextDaybooleanобязательно
    • statusstringобязательно

      lapsed: the venue did not answer by 2 hours before the start

      Значения: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullобязательно

      The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

    • cancelledBystring | nullобязательно

      Значения: "person", "venue"

    • teamobject | nullобязательно
      • idstringобязательно
      • namestringобязательно
    • matchobject | nullобязательно

      The match made from (or linked to) the booking, while it is not cancelled

      • idstringобязательно
    • wantsMatchbooleanобязательно
    • canCancelbooleanобязательно
    • canMakeMatchbooleanобязательно

      Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

  • pastobject[]обязательно
    • idstringобязательно
    • venueobjectобязательно
      • idstringобязательно
      • namestringобязательно
      • verifiedbooleanобязательно
      • slugstring | nullобязательно

        Null once the venue's page is gone

    • pitchobjectобязательно
      • idstringобязательно
      • namestringобязательно
    • startsAtstringобязательно
    • endsAtstringобязательно
    • durationMinnumberобязательно
    • venueDatestringобязательно

      The venue day it belongs to

    • nextDaybooleanобязательно
    • statusstringобязательно

      lapsed: the venue did not answer by 2 hours before the start

      Значения: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullобязательно

      The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

    • cancelledBystring | nullобязательно

      Значения: "person", "venue"

    • teamobject | nullобязательно
      • idstringобязательно
      • namestringобязательно
    • matchobject | nullобязательно

      The match made from (or linked to) the booking, while it is not cancelled

      • idstringобязательно
    • wantsMatchbooleanобязательно
    • canCancelbooleanобязательно
    • canMakeMatchbooleanобязательно

      Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

• DELETE/api/v1/reservations/{id}

  Cancel one of your bookings

  Нужен сеанс

  Waiting or confirmed, before it starts; the time is free again. 404 for someone else's booking; 409 fields.form: notActive, started.

  Показать поляСкрыть поля

  Параметры пути

  • idstringобязательно

  data в ответе

  • idstringобязательно
  • venueobjectобязательно
    • idstringобязательно
    • namestringобязательно
    • verifiedbooleanобязательно
    • slugstring | nullобязательно

      Null once the venue's page is gone

  • pitchobjectобязательно
    • idstringобязательно
    • namestringобязательно
  • startsAtstringобязательно
  • endsAtstringобязательно
  • durationMinnumberобязательно
  • venueDatestringобязательно

    The venue day it belongs to

  • nextDaybooleanобязательно
  • statusstringобязательно

    lapsed: the venue did not answer by 2 hours before the start

    Значения: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullобязательно

    The venue's words, or the app's own answer: "@taken" (another booking got the time), "@blocked" (the venue closed it), "@loginOff" (the venue stopped taking bookings), "@matchCancelled" (the match it was made for was called off)

  • cancelledBystring | nullобязательно

    Значения: "person", "venue"

  • teamobject | nullобязательно
    • idstringобязательно
    • namestringобязательно
  • matchobject | nullобязательно

    The match made from (or linked to) the booking, while it is not cancelled

    • idstringобязательно
  • wantsMatchbooleanобязательно
  • canCancelbooleanобязательно
  • canMakeMatchbooleanобязательно

    Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId