Geliştiriciler

Uç noktalar https://akilli.futbol/api/v1 altında; istekler ve yanıtlar JSON'dır.

Belgenin tamamı OpenAPI 3.1 biçiminde de var; Postman, Insomnia ya da istemci üreticilere doğrudan verebilirsin.

Uç noktaların özetleri ve notları OpenAPI belgesinden olduğu gibi gelir, bu yüzden İngilizcedir.

108 uç nokta, 16 bölüm.

1. 1

   Hesap aç ya da giriş yap: kullanıcı adı ve şifreyle POST /api/auth/sign-up/username ya da POST /api/auth/sign-in/username adresine JSON gönder.

   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

   Yanıtın set-auth-token başlığındaki imzalı token'ı cihazda güvenli bir yerde sakla. Bearer token olarak yalnızca bu token geçer: gövdedeki token ham oturum token'ıdır ve kabul edilmez.

   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

   Her istekte Authorization: Bearer <token> başlığını gönder.

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

Tarayıcıda web oturumunun çerezi de kabul edilir. Yanlış şifre ile olmayan kullanıcı adı aynı hatayı alır (401); askıya alınan hesaplar 403 BANNED_USER alır. Giriş denemeleri hem IP hem kullanıcı adı başına sınırlıdır (429).

Çıkış yapmak için POST /api/auth/sign-out, diğer bütün cihazlardan çıkış için POST /api/auth/revoke-other-sessions gönder; ikisi de gövde istemez. Oturum yalnızca istek 200 dönerse kapanır, bu yüzden yanıt kodunu kontrol et. POST /api/auth/change-password ile şifre değişince bu cihaz dahil bütün oturumlar kapanır ve yanıtın set-auth-token başlığında yeni bir token gelir: eskisinin yerine onu sakla.

Başarılı yanıtlar sonucu data alanında taşır. Hatalar error alanında bir kod, okunur bir mesaj ve gerektiğinde alan bazında hata kodları (fields) taşır.

{
  "data": { … }
}

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

Hata kodları

• 401UNAUTHENTICATEDOturum yok ya da token geçersiz: yeniden giriş yap.
• 403FORBIDDENBu işlem için yetkin yok.
• 404NOT_FOUNDKayıt yok ya da senin göremeyeceğin bir kayıt.
• 409CONFLICTİstek mevcut durumla çelişiyor; nedeni fields içinde.
• 422INVALIDGövde ya da alanlar geçersiz; her alanın hata kodu fields içinde.
• 429RATE_LIMITEDÇok fazla istek: biraz bekleyip tekrar dene.
• 500INTERNALSunucuda bir sorun çıktı: biraz sonra tekrar dene.

/api/v1 altında olmayan bir yol da bu biçimde 404 NOT_FOUND döner; bir yolun desteklemediği yöntem ise boş gövdeli 405 alır.

/api/auth altındaki uç noktalar Better Auth'a aittir: yanıtları data sarmalı olmadan gelir, hataları da code ve message alanlarıyla döner.

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

  Create an account and sign in

  Oturum gerekmez

  The signed session token is in the set-auth-token response header: keep it and send it as Authorization: Bearer <token>. 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 uç noktası: yanıtı data sarmalı olmadan gelir.

  Alanları gösterAlanları gizle

  İstek gövdesi

  • displayNamestringzorunlu

    2–40 characters

  • usernamestringzorunlu

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

  • passwordstringzorunlu

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

  • positionsstring[]isteğe bağlı

    Değerler: "goalkeeper", "defender", "midfielder", "forward"

  • adultbooleanzorunlu

    Değerler: true

  • privacyNoticebooleanzorunlu

    Değerler: true

  • termsbooleanzorunlu

    Değerler: true

  • localestringzorunlu

    Değerler: "tr", "en"

  Yanıt gövdesi

  • userobjectzorunlu
    • idstringzorunlu
    • usernamestringzorunlu
• POST/api/auth/sign-in/username

  Sign in

  Oturum gerekmez

  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 uç noktası: yanıtı data sarmalı olmadan gelir.

  Alanları gösterAlanları gizle

  İstek gövdesi

  • usernamestringzorunlu
  • passwordstringzorunlu
  • rememberMebooleanisteğe bağlı

  Yanıt gövdesi

  • redirectbooleanzorunlu

    Always false

  • tokenstringzorunlu

    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>.

  • userobjectzorunlu
    • idstringzorunlu
    • usernamestringzorunlu

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

    • displayUsernamestringzorunlu
    • namestringzorunlu

      The display name

    • emailstringzorunlu

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

    • emailVerifiedbooleanzorunlu
    • imagestring | nullzorunlu
    • rolestring | nullzorunlu

      "admin" or "user"

    • bannedboolean | nullzorunlu
    • banReasonstring | nullzorunlu
    • banExpiresstring | nullzorunlu
    • createdAtstringzorunlu
    • updatedAtstringzorunlu
• POST/api/auth/is-username-available

  Check whether a username is free

  Oturum gerekmez

  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 uç noktası: yanıtı data sarmalı olmadan gelir.

  Alanları gösterAlanları gizle

  İstek gövdesi

  • usernamestringzorunlu

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

  Yanıt gövdesi

  • availablebooleanzorunlu
• POST/api/auth/sign-out

  Sign out (ends this session)

  Oturum gerekir

  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 uç noktası: yanıtı data sarmalı olmadan gelir.

  Alanları gösterAlanları gizle

  İstek gövdesi

  Alan yok.

  Yanıt gövdesi

  • successbooleanzorunlu
• GET/api/auth/get-session

  The current session and user

  Oturum gerekir

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

  Better Auth uç noktası: yanıtı data sarmalı olmadan gelir.

  Alanları gösterAlanları gizle

  Yanıt gövdesi

  • sessionobjectzorunlu
    • idstringzorunlu
    • userIdstringzorunlu
    • tokenstringzorunlu

      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>.

    • expiresAtstringzorunlu

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

    • createdAtstringzorunlu
    • updatedAtstringzorunlu
    • ipAddressstring | nullzorunlu
    • userAgentstring | nullzorunlu
    • impersonatedBystring | nullzorunlu
  • userobjectzorunlu
    • idstringzorunlu
    • usernamestringzorunlu

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

    • displayUsernamestringzorunlu
    • namestringzorunlu

      The display name

    • emailstringzorunlu

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

    • emailVerifiedbooleanzorunlu
    • imagestring | nullzorunlu
    • rolestring | nullzorunlu

      "admin" or "user"

    • bannedboolean | nullzorunlu
    • banReasonstring | nullzorunlu
    • banExpiresstring | nullzorunlu
    • createdAtstringzorunlu
    • updatedAtstringzorunlu
• POST/api/auth/change-password

  Change the password

  Oturum gerekir

  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 uç noktası: yanıtı data sarmalı olmadan gelir.

  Alanları gösterAlanları gizle

  İstek gövdesi

  • currentPasswordstringzorunlu
  • newPasswordstringzorunlu

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

  Yanıt gövdesi

  • tokenstringzorunlu

    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>.

  • userobjectzorunlu
    • idstringzorunlu
    • usernamestringzorunlu

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

    • displayUsernamestringzorunlu
    • namestringzorunlu

      The display name

    • emailstringzorunlu

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

    • emailVerifiedbooleanzorunlu
    • imagestring | nullzorunlu
    • rolestring | nullzorunlu

      "admin" or "user"

    • bannedboolean | nullzorunlu
    • banReasonstring | nullzorunlu
    • banExpiresstring | nullzorunlu
    • createdAtstringzorunlu
    • updatedAtstringzorunlu
• POST/api/auth/revoke-other-sessions

  Sign out every other device

  Oturum gerekir

  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 uç noktası: yanıtı data sarmalı olmadan gelir.

  Alanları gösterAlanları gizle

  İstek gövdesi

  Alan yok.

  Yanıt gövdesi

  • statusbooleanzorunlu

• GET/api/v1/me

  Your profile settings

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yanıttaki data

  • idstringzorunlu

    The player id

  • userIdstringzorunlu
  • usernamestringzorunlu

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

  • handlestringzorunlu
  • displayNamestringzorunlu
  • positionsstring[]zorunlu

    Değerler: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullzorunlu

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

    • smallstringzorunlu

      128 px

    • mediumstringzorunlu

      512 px

    • largestringzorunlu

      1024 px

  • visibilitystringzorunlu

    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

    Değerler: "public", "teammates", "private"

  • rolestring | nullzorunlu

    "admin" or "user"

  • activeSessionsintegerzorunlu

    Signed-in devices, this one included

• PATCH/api/v1/me

  Change your display name, positions or visibility

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  İstek gövdesi

  • displayNamestringisteğe bağlı

    en az 1 karakter

  • positionsstring[]isteğe bağlı

    Değerler: "goalkeeper", "defender", "midfielder", "forward"

  • visibilitystringisteğe bağlı

    Değerler: "public", "teammates", "private"

  Yanıttaki data

  • idstringzorunlu

    The player id

  • userIdstringzorunlu
  • usernamestringzorunlu

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

  • handlestringzorunlu
  • displayNamestringzorunlu
  • positionsstring[]zorunlu

    Değerler: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullzorunlu

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

    • smallstringzorunlu

      128 px

    • mediumstringzorunlu

      512 px

    • largestringzorunlu

      1024 px

  • visibilitystringzorunlu

    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

    Değerler: "public", "teammates", "private"

  • rolestring | nullzorunlu

    "admin" or "user"

  • activeSessionsintegerzorunlu

    Signed-in devices, this one included

• GET/api/v1/me/photo

  Your profile photo

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yanıttaki data

  • photoobject | nullzorunlu

    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

    • smallstringzorunlu

      128 px

    • mediumstringzorunlu

      512 px

    • largestringzorunlu

      1024 px

• PUT/api/v1/me/photo

  Upload or replace your profile photo

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yanıttaki data

  • photoobject | nullzorunlu

    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

    • smallstringzorunlu

      128 px

    • mediumstringzorunlu

      512 px

    • largestringzorunlu

      1024 px

• DELETE/api/v1/me/photo

  Remove your profile photo

  Oturum gerekir

  Your initials show again. Fine without a photo.

  Alanları gösterAlanları gizle

  Yanıttaki data

  • photoobject | nullzorunlu

    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

    • smallstringzorunlu

      128 px

    • mediumstringzorunlu

      512 px

    • largestringzorunlu

      1024 px

• GET/api/v1/teams

  Teams the caller plays for (archived teams left out)

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yanıttaki data

  Tür: object[]

  Her öğenin alanları:

  • idstring (uuid)zorunlu
  • slugstringzorunlu

    URL slug, e.g. kartallar-7k2m

  • namestringzorunlu
  • citystring | nullzorunlu
  • kitHomeHexstringzorunlu

    #rrggbb, lower-case

  • kitAwayHexstring | nullzorunlu

    #rrggbb, lower-case

  • crestobject | nullzorunlu

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

    • shapestringzorunlu

      Değerler: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringzorunlu
    • secondarystringzorunlu
    • letterstringzorunlu
    • patternstringisteğe bağlı

      Değerler: "plain", "split", "stripes", "sash", "chevron", "hoops"Varsayılan: "plain"

    • detailstringisteğe bağlı

      Değerler: "none", "star", "ball", "crown", "laurel", "wings"Varsayılan: "none"

  • rolestringzorunlu

    The caller's role in the team

    Değerler: "captain", "co_captain", "member"

  • memberCountintegerzorunlu
• 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).

  Oturum gerekir

  Alanları gösterAlanları gizle

  İstek gövdesi

  • namestringzorunlu

    2–40 karakter

  • citystring | nullisteğe bağlı

    en çok 60 karakter

  • kitHomeHexstringzorunlu
  • kitAwayHexstring | nullisteğe bağlı
  • crestobject | nullisteğe bağlı
    • shapestringzorunlu

      Değerler: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringzorunlu
    • secondarystringzorunlu
    • letterstringzorunlu
    • patternstringisteğe bağlı

      Değerler: "plain", "split", "stripes", "sash", "chevron", "hoops"Varsayılan: "plain"

    • detailstringisteğe bağlı

      Değerler: "none", "star", "ball", "crown", "laurel", "wings"Varsayılan: "none"

  Yanıttaki data

  • idstring (uuid)zorunlu
  • slugstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • kitHomeHexstringzorunlu

    #rrggbb, lower-case

  • kitAwayHexstring | nullzorunlu

    #rrggbb, lower-case

  • crestobject | nullzorunlu
    • shapestringzorunlu

      Değerler: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringzorunlu
    • secondarystringzorunlu
    • letterstringzorunlu
    • patternstringisteğe bağlı

      Değerler: "plain", "split", "stripes", "sash", "chevron", "hoops"Varsayılan: "plain"

    • detailstringisteğe bağlı

      Değerler: "none", "star", "ball", "crown", "laurel", "wings"Varsayılan: "none"

  • archivedAtstring (date-time) | nullzorunlu
  • createdAtstring (date-time)zorunlu
  • memberCountintegerzorunlu
  • viewerobjectzorunlu
    • rolestring | nullzorunlu

      Null for an admin who is not a member

      Değerler: "captain", "co_captain", "member"

    • canEditbooleanzorunlu
    • canRotateCodebooleanzorunlu
    • canArchivebooleanzorunlu
    • mustHandOverbooleanzorunlu

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

    • onlyMemberbooleanzorunlu

      Leaving would archive the team

  • codestring | nullzorunlu

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullzorunlu

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

  • membersobject[]zorunlu

    Captains first, then co-captains, then players

    • playerIdstring (uuid)zorunlu
    • displayNamestringzorunlu
    • handlestring | nullzorunlu

      Null for guests

    • kindstringzorunlu

      Değerler: "registered", "guest"

    • positionsstring[]zorunlu

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

      Değerler: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullzorunlu

      Follows the member's visibility, like the positions

      • smallstringzorunlu

        128 px

      • mediumstringzorunlu

        512 px

      • largestringzorunlu

        1024 px

    • rolestringzorunlu

      Değerler: "captain", "co_captain", "member"

    • numberinteger | nullzorunlu
    • joinedAtstring (date-time)zorunlu
    • isViewerbooleanzorunlu
    • canobjectzorunlu
      • rolesstring[]zorunlu

        Roles the caller may give this member

        Değerler: "captain", "co_captain", "member"

      • removebooleanzorunlu
  • matchesobjectzorunlu

    Up to 5 each

    • upcomingobject[]zorunlu
      • idstring (uuid)zorunlu
      • startsAtstring (date-time)zorunlu
      • statusstringzorunlu

        Değerler: "planned", "played", "cancelled"

      • titlestring | nullzorunlu
      • venueobject | nullzorunlu
        • namestringzorunlu
        • verifiedbooleanzorunlu
      • sidesobject[]zorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsinteger | nullzorunlu
        • oursbooleanzorunlu

          This team plays on this side

    • recentobject[]zorunlu
      • idstring (uuid)zorunlu
      • startsAtstring (date-time)zorunlu
      • statusstringzorunlu

        Değerler: "planned", "played", "cancelled"

      • titlestring | nullzorunlu
      • venueobject | nullzorunlu
        • namestringzorunlu
        • verifiedbooleanzorunlu
      • sidesobject[]zorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsinteger | nullzorunlu
        • oursbooleanzorunlu

          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.

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yol parametreleri

  • slugstringzorunlu

  Yanıttaki data

  • idstring (uuid)zorunlu
  • slugstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • kitHomeHexstringzorunlu

    #rrggbb, lower-case

  • kitAwayHexstring | nullzorunlu

    #rrggbb, lower-case

  • crestobject | nullzorunlu
    • shapestringzorunlu

      Değerler: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringzorunlu
    • secondarystringzorunlu
    • letterstringzorunlu
    • patternstringisteğe bağlı

      Değerler: "plain", "split", "stripes", "sash", "chevron", "hoops"Varsayılan: "plain"

    • detailstringisteğe bağlı

      Değerler: "none", "star", "ball", "crown", "laurel", "wings"Varsayılan: "none"

  • archivedAtstring (date-time) | nullzorunlu
  • createdAtstring (date-time)zorunlu
  • memberCountintegerzorunlu
  • viewerobjectzorunlu
    • rolestring | nullzorunlu

      Null for an admin who is not a member

      Değerler: "captain", "co_captain", "member"

    • canEditbooleanzorunlu
    • canRotateCodebooleanzorunlu
    • canArchivebooleanzorunlu
    • mustHandOverbooleanzorunlu

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

    • onlyMemberbooleanzorunlu

      Leaving would archive the team

  • codestring | nullzorunlu

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullzorunlu

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

  • membersobject[]zorunlu

    Captains first, then co-captains, then players

    • playerIdstring (uuid)zorunlu
    • displayNamestringzorunlu
    • handlestring | nullzorunlu

      Null for guests

    • kindstringzorunlu

      Değerler: "registered", "guest"

    • positionsstring[]zorunlu

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

      Değerler: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullzorunlu

      Follows the member's visibility, like the positions

      • smallstringzorunlu

        128 px

      • mediumstringzorunlu

        512 px

      • largestringzorunlu

        1024 px

    • rolestringzorunlu

      Değerler: "captain", "co_captain", "member"

    • numberinteger | nullzorunlu
    • joinedAtstring (date-time)zorunlu
    • isViewerbooleanzorunlu
    • canobjectzorunlu
      • rolesstring[]zorunlu

        Roles the caller may give this member

        Değerler: "captain", "co_captain", "member"

      • removebooleanzorunlu
  • matchesobjectzorunlu

    Up to 5 each

    • upcomingobject[]zorunlu
      • idstring (uuid)zorunlu
      • startsAtstring (date-time)zorunlu
      • statusstringzorunlu

        Değerler: "planned", "played", "cancelled"

      • titlestring | nullzorunlu
      • venueobject | nullzorunlu
        • namestringzorunlu
        • verifiedbooleanzorunlu
      • sidesobject[]zorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsinteger | nullzorunlu
        • oursbooleanzorunlu

          This team plays on this side

    • recentobject[]zorunlu
      • idstring (uuid)zorunlu
      • startsAtstring (date-time)zorunlu
      • statusstringzorunlu

        Değerler: "planned", "played", "cancelled"

      • titlestring | nullzorunlu
      • venueobject | nullzorunlu
        • namestringzorunlu
        • verifiedbooleanzorunlu
      • sidesobject[]zorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsinteger | nullzorunlu
        • oursbooleanzorunlu

          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.

  Oturum gerekir

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

  Alanları gösterAlanları gizle

  Yol parametreleri

  • slugstringzorunlu

  İstek gövdesi

  • namestringisteğe bağlı

    2–40 karakter

  • citystring | nullisteğe bağlı

    en çok 60 karakter

  • kitHomeHexstringisteğe bağlı
  • kitAwayHexstring | nullisteğe bağlı
  • crestobject | nullisteğe bağlı
    • shapestringzorunlu

      Değerler: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringzorunlu
    • secondarystringzorunlu
    • letterstringzorunlu
    • patternstringisteğe bağlı

      Değerler: "plain", "split", "stripes", "sash", "chevron", "hoops"Varsayılan: "plain"

    • detailstringisteğe bağlı

      Değerler: "none", "star", "ball", "crown", "laurel", "wings"Varsayılan: "none"

  Yanıttaki data

  • idstring (uuid)zorunlu
  • slugstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • kitHomeHexstringzorunlu

    #rrggbb, lower-case

  • kitAwayHexstring | nullzorunlu

    #rrggbb, lower-case

  • crestobject | nullzorunlu
    • shapestringzorunlu

      Değerler: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringzorunlu
    • secondarystringzorunlu
    • letterstringzorunlu
    • patternstringisteğe bağlı

      Değerler: "plain", "split", "stripes", "sash", "chevron", "hoops"Varsayılan: "plain"

    • detailstringisteğe bağlı

      Değerler: "none", "star", "ball", "crown", "laurel", "wings"Varsayılan: "none"

  • archivedAtstring (date-time) | nullzorunlu
  • createdAtstring (date-time)zorunlu
  • memberCountintegerzorunlu
  • viewerobjectzorunlu
    • rolestring | nullzorunlu

      Null for an admin who is not a member

      Değerler: "captain", "co_captain", "member"

    • canEditbooleanzorunlu
    • canRotateCodebooleanzorunlu
    • canArchivebooleanzorunlu
    • mustHandOverbooleanzorunlu

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

    • onlyMemberbooleanzorunlu

      Leaving would archive the team

  • codestring | nullzorunlu

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullzorunlu

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

  • membersobject[]zorunlu

    Captains first, then co-captains, then players

    • playerIdstring (uuid)zorunlu
    • displayNamestringzorunlu
    • handlestring | nullzorunlu

      Null for guests

    • kindstringzorunlu

      Değerler: "registered", "guest"

    • positionsstring[]zorunlu

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

      Değerler: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullzorunlu

      Follows the member's visibility, like the positions

      • smallstringzorunlu

        128 px

      • mediumstringzorunlu

        512 px

      • largestringzorunlu

        1024 px

    • rolestringzorunlu

      Değerler: "captain", "co_captain", "member"

    • numberinteger | nullzorunlu
    • joinedAtstring (date-time)zorunlu
    • isViewerbooleanzorunlu
    • canobjectzorunlu
      • rolesstring[]zorunlu

        Roles the caller may give this member

        Değerler: "captain", "co_captain", "member"

      • removebooleanzorunlu
  • matchesobjectzorunlu

    Up to 5 each

    • upcomingobject[]zorunlu
      • idstring (uuid)zorunlu
      • startsAtstring (date-time)zorunlu
      • statusstringzorunlu

        Değerler: "planned", "played", "cancelled"

      • titlestring | nullzorunlu
      • venueobject | nullzorunlu
        • namestringzorunlu
        • verifiedbooleanzorunlu
      • sidesobject[]zorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsinteger | nullzorunlu
        • oursbooleanzorunlu

          This team plays on this side

    • recentobject[]zorunlu
      • idstring (uuid)zorunlu
      • startsAtstring (date-time)zorunlu
      • statusstringzorunlu

        Değerler: "planned", "played", "cancelled"

      • titlestring | nullzorunlu
      • venueobject | nullzorunlu
        • namestringzorunlu
        • verifiedbooleanzorunlu
      • sidesobject[]zorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsinteger | nullzorunlu
        • oursbooleanzorunlu

          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

  Oturum gerekir

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

  Alanları gösterAlanları gizle

  Yol parametreleri

  • slugstringzorunlu

  Yanıttaki data

  • codestringzorunlu
  • inviteUrlstring (uri)zorunlu
• 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.

  Oturum gerekir

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

  Alanları gösterAlanları gizle

  Yol parametreleri

  • slugstringzorunlu
  • playerIdstringzorunlu

  İstek gövdesi

  • rolestringzorunlu

    Değerler: "captain", "co_captain", "member"

  Yanıttaki data

  • playerIdstring (uuid)zorunlu
  • rolestringzorunlu

    Değerler: "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.

  Oturum gerekir

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

  Alanları gösterAlanları gizle

  Yol parametreleri

  • slugstringzorunlu
  • playerIdstringzorunlu

  Yanıttaki data

  • archivedbooleanzorunlu
• 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.

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yol parametreleri

  • slugstringzorunlu

  Yanıttaki data

  • archivedbooleanzorunlu

    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

  Oturum gerekir

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

  Alanları gösterAlanları gizle

  Yol parametreleri

  • slugstringzorunlu

  Yanıttaki data

  • archivedAtstring (date-time)zorunlu

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

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

  Oturum gerekmez

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • codestringzorunlu

  Yanıttaki data

  • kindstringzorunlu

    Değerler: "team", "match"

  • codestringzorunlu

    The canonical code: six capital letters

  • teamobjectisteğe bağlı
    • idstringzorunlu
    • slugstringzorunlu
    • namestringzorunlu
    • citystring | nullzorunlu
    • kitHomeHexstringzorunlu

      #rrggbb

    • kitAwayHexstring | nullzorunlu
    • memberCountintegerzorunlu
    • captainobject | nullzorunlu

      Null when signed out

      • idstringzorunlu
      • displayNamestringzorunlu
      • handlestring | nullzorunlu
      • photoobject | nullzorunlu

        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

        • smallstringzorunlu

          128 px

        • mediumstringzorunlu

          512 px

        • largestringzorunlu

          1024 px

    • archivedbooleanzorunlu

      Closed teams take no new members

  • viewerobjectzorunlu
    • signedInbooleanzorunlu
    • memberbooleanzorunlu
    • rolestring | nullzorunlu

      Değerler: "captain", "co_captain", "member"

    • canJoinbooleanzorunlu
  • matchobjectisteğe bağlı
    • idstringzorunlu
    • kindstringzorunlu

      Değerler: "fixture", "pickup"

    • statusstringzorunlu

      Değerler: "planned", "played", "cancelled"

    • statestringzorunlu

      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.

      Değerler: "open", "cancelled", "finished"

    • titlestring | nullzorunlu
    • startsAtstringzorunlu

      ISO 8601

    • durationMinintegerzorunlu
    • venueobject | nullzorunlu
      • namestringzorunlu
      • citystring | nullzorunlu
      • districtstring | nullzorunlu
      • addressstring | nullzorunlu
      • verifiedbooleanzorunlu
    • pitchobject | nullzorunlu
      • namestringzorunlu
      • indoorbooleanzorunlu
    • sidesobject[]zorunlu
      • sidestringzorunlu

        Değerler: "A", "B"

      • labelstringzorunlu
      • goalsinteger | nullzorunlu
      • teamobject | nullzorunlu
        • slugstringzorunlu
        • namestringzorunlu
    • comingobjectzorunlu

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

      • Aintegerzorunlu
      • Bintegerzorunlu
      • noneintegerzorunlu
      • totalintegerzorunlu
      • maybeintegerzorunlu
    • playersobject[]zorunlu

      Who said yes or maybe; empty when signed out

      • idstringzorunlu
      • displayNamestringzorunlu
      • sidestring | nullzorunlu

        Değerler: "A", "B"

      • rsvpstringzorunlu

        Değerler: "yes", "maybe"

      • youbooleanzorunlu
      • photoobject | nullzorunlu

        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

        • smallstringzorunlu

          128 px

        • mediumstringzorunlu

          512 px

        • largestringzorunlu

          1024 px

    • organizerobject | nullzorunlu

      Null when signed out

      • displayNamestringzorunlu
• POST/api/v1/join/{code}

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

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • codestringzorunlu

  İstek gövdesi

  • rsvpstringisteğe bağlı

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

    Değerler: "yes", "maybe", "no"

  Yanıttaki data

  • kindstringzorunlu

    Değerler: "team", "match"

  • teamobjectisteğe bağlı
    • idstringzorunlu
    • slugstringzorunlu
    • namestringzorunlu
  • rolestringisteğe bağlı

    Değerler: "captain", "co_captain", "member"

  • alreadyMemberbooleanisteğe bağlı
  • matchobjectisteğe bağlı
    • idstringzorunlu
  • participantobjectisteğe bağlı
    • rsvpstringzorunlu

      Değerler: "invited", "yes", "maybe", "no"

    • sidestring | nullzorunlu

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

      Değerler: "A", "B"

    • respondedAtstring | nullzorunlu

• GET/api/v1/matches

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

  Oturum gerekir

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

  Alanları gösterAlanları gizle

  Yanıttaki data

  • upcomingobject[]zorunlu
    • idstringzorunlu
    • titlestring | nullzorunlu
    • kindstringzorunlu

      Değerler: "pickup", "fixture"

    • statusstringzorunlu

      Değerler: "planned", "played", "cancelled"

    • startsAtstringzorunlu

      ISO 8601 (UTC)

    • durationMinnumberzorunlu
    • scoreStatestringzorunlu

      Değerler: "none", "entered", "confirmed"

    • venueobject | nullzorunlu
      • namestringzorunlu
      • districtstring | nullzorunlu
      • citystring | nullzorunlu
      • verifiedbooleanzorunlu
    • pitchobject | nullzorunlu
      • namestringzorunlu
    • sidesobjectzorunlu
      • Aobjectzorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsnumber | nullzorunlu

          Null until the score is entered

        • bibHexstring | nullzorunlu
        • teamIdstring | nullzorunlu
        • teamNamestring | nullzorunlu
      • Bobjectzorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsnumber | nullzorunlu

          Null until the score is entered

        • bibHexstring | nullzorunlu
        • teamIdstring | nullzorunlu
        • teamNamestring | nullzorunlu
    • comingnumberzorunlu

      How many said "yes"

    • meobjectzorunlu
      • rsvpstring | nullzorunlu

        Değerler: "invited", "yes", "maybe", "no"

      • sidestring | nullzorunlu

        Değerler: "A", "B"

      • isOrganizerbooleanzorunlu
    • canRespondbooleanzorunlu
  • pastobject[]zorunlu
    • idstringzorunlu
    • titlestring | nullzorunlu
    • kindstringzorunlu

      Değerler: "pickup", "fixture"

    • statusstringzorunlu

      Değerler: "planned", "played", "cancelled"

    • startsAtstringzorunlu

      ISO 8601 (UTC)

    • durationMinnumberzorunlu
    • scoreStatestringzorunlu

      Değerler: "none", "entered", "confirmed"

    • venueobject | nullzorunlu
      • namestringzorunlu
      • districtstring | nullzorunlu
      • citystring | nullzorunlu
      • verifiedbooleanzorunlu
    • pitchobject | nullzorunlu
      • namestringzorunlu
    • sidesobjectzorunlu
      • Aobjectzorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsnumber | nullzorunlu

          Null until the score is entered

        • bibHexstring | nullzorunlu
        • teamIdstring | nullzorunlu
        • teamNamestring | nullzorunlu
      • Bobjectzorunlu
        • sidestringzorunlu

          Değerler: "A", "B"

        • labelstringzorunlu
        • goalsnumber | nullzorunlu

          Null until the score is entered

        • bibHexstring | nullzorunlu
        • teamIdstring | nullzorunlu
        • teamNamestring | nullzorunlu
    • comingnumberzorunlu

      How many said "yes"

    • meobjectzorunlu
      • rsvpstring | nullzorunlu

        Değerler: "invited", "yes", "maybe", "no"

      • sidestring | nullzorunlu

        Değerler: "A", "B"

      • isOrganizerbooleanzorunlu
    • canRespondbooleanzorunlu
• POST/api/v1/matches

  Create a match

  Oturum gerekir

  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. 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; reservationId = invalid (not your confirmed booking), 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.

  Alanları gösterAlanları gizle

  İstek gövdesi

  • titlestring | nullisteğe bağlı

    Up to 60 characters

  • kindstringisteğe bağlı

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

    Değerler: "pickup", "fixture"

  • datestringisteğe bağlı

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

  • timestringisteğe bağlı

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

  • startsAtstringisteğe bağlı

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

  • durationMinnumberisteğe bağlı

    Default 60

    Değerler: 60, 90, 120

  • venueIdstring | nullisteğe bağlı
  • pitchIdstring | nullisteğe bağlı

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

  • recordingstringisteğe bağlı

    official only on a pitch with an official camera

    Değerler: "upload", "official"

  • sidesobjectisteğe bağlı

    Default labels "Turuncular" and "Maviler"

    • Aobjectzorunlu
      • labelstringzorunlu

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

      • teamIdstring | nullisteğe bağlı

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

      • bibHexstring | nullisteğe bağlı

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

    • Bobjectzorunlu
      • labelstringzorunlu

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

      • teamIdstring | nullisteğe bağlı

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

      • bibHexstring | nullisteğe bağlı

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

  • invitedTeamIdsstring[]isteğe bağlı

    Your teams whose members all get an invitation

  • notesstring | nullisteğe bağlı

    Up to 500 characters

  • reservationIdstringisteğe bağlı

    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)

  Yanıttaki data

  • idstringzorunlu
  • codestringzorunlu
  • inviteUrlstring (uri)zorunlu

    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

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  Yanıttaki data

  • idstringzorunlu
  • titlestring | nullzorunlu
  • kindstringzorunlu

    Değerler: "pickup", "fixture"

  • statusstringzorunlu

    Değerler: "planned", "played", "cancelled"

  • startsAtstringzorunlu
  • endsAtstringzorunlu
  • durationMinnumberzorunlu
  • recordingstringzorunlu

    Değerler: "upload", "official"

  • scoreStatestringzorunlu

    Değerler: "none", "entered", "confirmed"

  • notesstring | nullzorunlu
  • cancelledAtstring | nullzorunlu
  • organizerobjectzorunlu
    • playerIdstringzorunlu
    • displayNamestringzorunlu
    • handlestring | nullzorunlu
  • venueobject | nullzorunlu
    • idstringzorunlu
    • namestringzorunlu
    • citystring | nullzorunlu
    • districtstring | nullzorunlu
    • addressstring | nullzorunlu
    • verifiedbooleanzorunlu
    • slugstring | nullzorunlu

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

  • pitchobject | nullzorunlu
    • idstringzorunlu
    • namestringzorunlu
    • indoorbooleanzorunlu
    • officialCamerabooleanzorunlu
  • cameraobject | nullzorunlu

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

    • idstringzorunlu
    • labelstringzorunlu
    • officialbooleanzorunlu
  • sidesobjectzorunlu
    • Aobjectzorunlu
      • sidestringzorunlu

        Değerler: "A", "B"

      • labelstringzorunlu
      • goalsnumber | nullzorunlu

        Null until the score is entered

      • bibHexstring | nullzorunlu
      • teamIdstring | nullzorunlu
      • teamNamestring | nullzorunlu
    • Bobjectzorunlu
      • sidestringzorunlu

        Değerler: "A", "B"

      • labelstringzorunlu
      • goalsnumber | nullzorunlu

        Null until the score is entered

      • bibHexstring | nullzorunlu
      • teamIdstring | nullzorunlu
      • teamNamestring | nullzorunlu
  • participantsobject[]zorunlu
    • playerIdstringzorunlu
    • displayNamestringzorunlu
    • handlestring | nullzorunlu

      Null for guests

    • kindstringzorunlu

      Değerler: "registered", "guest"

    • sidestring | nullzorunlu

      Değerler: "A", "B"

    • rsvpstringzorunlu

      Değerler: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullzorunlu
    • attendedbooleanzorunlu
    • isOrganizerbooleanzorunlu
    • positionsstring[]zorunlu

      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

      Değerler: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullzorunlu

      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

      • smallstringzorunlu

        128 px

      • mediumstringzorunlu

        512 px

      • largestringzorunlu

        1024 px

  • teamsobject[]zorunlu
    • teamIdstringzorunlu
    • namestringzorunlu
    • sidestring | nullzorunlu

      Değerler: "A", "B"

    • membersnumberzorunlu
  • codestring | nullzorunlu

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

  • inviteUrlstring (uri) | nullzorunlu

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

  • hasVideobooleanzorunlu
  • kickedOffbooleanzorunlu
  • endedbooleanzorunlu

    Kick-off plus the duration has passed

  • viewerobjectzorunlu
    • playerIdstringzorunlu

      Your player id, to find yourself in participants

    • canManagebooleanzorunlu
    • isOrganizerbooleanzorunlu
    • isAdminbooleanzorunlu
    • rsvpstring | nullzorunlu

      Değerler: "invited", "yes", "maybe", "no"

    • sidestring | nullzorunlu

      Değerler: "A", "B"

    • canRespondbooleanzorunlu
• PATCH/api/v1/matches/{id}

  Change a match (managers)

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  İstek gövdesi

  • titlestring | nullisteğe bağlı

    Up to 60 characters

  • kindstringisteğe bağlı

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

    Değerler: "pickup", "fixture"

  • datestringisteğe bağlı

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

  • timestringisteğe bağlı

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

  • startsAtstringisteğe bağlı

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

  • durationMinnumberisteğe bağlı

    Default 60

    Değerler: 60, 90, 120

  • venueIdstring | nullisteğe bağlı
  • pitchIdstring | nullisteğe bağlı

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

  • recordingstringisteğe bağlı

    official only on a pitch with an official camera

    Değerler: "upload", "official"

  • notesstring | nullisteğe bağlı

    Up to 500 characters

  • sidesobjectisteğe bağlı

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

    • Aobjectisteğe bağlı
      • labelstringisteğe bağlı

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

      • teamIdstring | nullisteğe bağlı

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

      • bibHexstring | nullisteğe bağlı

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

    • Bobjectisteğe bağlı
      • labelstringisteğe bağlı

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

      • teamIdstring | nullisteğe bağlı

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

      • bibHexstring | nullisteğe bağlı

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

  Yanıttaki data

  • idstringzorunlu
  • titlestring | nullzorunlu
  • kindstringzorunlu

    Değerler: "pickup", "fixture"

  • statusstringzorunlu

    Değerler: "planned", "played", "cancelled"

  • startsAtstringzorunlu
  • endsAtstringzorunlu
  • durationMinnumberzorunlu
  • recordingstringzorunlu

    Değerler: "upload", "official"

  • scoreStatestringzorunlu

    Değerler: "none", "entered", "confirmed"

  • notesstring | nullzorunlu
  • cancelledAtstring | nullzorunlu
  • organizerobjectzorunlu
    • playerIdstringzorunlu
    • displayNamestringzorunlu
    • handlestring | nullzorunlu
  • venueobject | nullzorunlu
    • idstringzorunlu
    • namestringzorunlu
    • citystring | nullzorunlu
    • districtstring | nullzorunlu
    • addressstring | nullzorunlu
    • verifiedbooleanzorunlu
    • slugstring | nullzorunlu

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

  • pitchobject | nullzorunlu
    • idstringzorunlu
    • namestringzorunlu
    • indoorbooleanzorunlu
    • officialCamerabooleanzorunlu
  • cameraobject | nullzorunlu

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

    • idstringzorunlu
    • labelstringzorunlu
    • officialbooleanzorunlu
  • sidesobjectzorunlu
    • Aobjectzorunlu
      • sidestringzorunlu

        Değerler: "A", "B"

      • labelstringzorunlu
      • goalsnumber | nullzorunlu

        Null until the score is entered

      • bibHexstring | nullzorunlu
      • teamIdstring | nullzorunlu
      • teamNamestring | nullzorunlu
    • Bobjectzorunlu
      • sidestringzorunlu

        Değerler: "A", "B"

      • labelstringzorunlu
      • goalsnumber | nullzorunlu

        Null until the score is entered

      • bibHexstring | nullzorunlu
      • teamIdstring | nullzorunlu
      • teamNamestring | nullzorunlu
  • participantsobject[]zorunlu
    • playerIdstringzorunlu
    • displayNamestringzorunlu
    • handlestring | nullzorunlu

      Null for guests

    • kindstringzorunlu

      Değerler: "registered", "guest"

    • sidestring | nullzorunlu

      Değerler: "A", "B"

    • rsvpstringzorunlu

      Değerler: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullzorunlu
    • attendedbooleanzorunlu
    • isOrganizerbooleanzorunlu
    • positionsstring[]zorunlu

      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

      Değerler: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullzorunlu

      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

      • smallstringzorunlu

        128 px

      • mediumstringzorunlu

        512 px

      • largestringzorunlu

        1024 px

  • teamsobject[]zorunlu
    • teamIdstringzorunlu
    • namestringzorunlu
    • sidestring | nullzorunlu

      Değerler: "A", "B"

    • membersnumberzorunlu
  • codestring | nullzorunlu

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

  • inviteUrlstring (uri) | nullzorunlu

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

  • hasVideobooleanzorunlu
  • kickedOffbooleanzorunlu
  • endedbooleanzorunlu

    Kick-off plus the duration has passed

  • viewerobjectzorunlu
    • playerIdstringzorunlu

      Your player id, to find yourself in participants

    • canManagebooleanzorunlu
    • isOrganizerbooleanzorunlu
    • isAdminbooleanzorunlu
    • rsvpstring | nullzorunlu

      Değerler: "invited", "yes", "maybe", "no"

    • sidestring | nullzorunlu

      Değerler: "A", "B"

    • canRespondbooleanzorunlu
• POST/api/v1/matches/{id}/cancel

  Cancel a match (managers)

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  Yanıttaki data

  • idstringzorunlu
  • statusstringzorunlu

    Değerler: "cancelled"

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

  Renew the match's join code (managers)

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  Yanıttaki data

  • codestringzorunlu

    6 letters A–Z without I and O

  • inviteUrlstring (uri)zorunlu

    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

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  İstek gövdesi

  • answerstringzorunlu

    Değerler: "yes", "maybe", "no"

  Yanıttaki data

  • rsvpstringzorunlu

    Değerler: "invited", "yes", "maybe", "no"

  • sidestring | nullzorunlu

    Değerler: "A", "B"

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

  Invite one of your teams (managers)

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  İstek gövdesi

  • teamIdstringzorunlu
  • sidestring | nullisteğe bağlı

    Değerler: "A", "B"

  Yanıttaki data

  • invitednumberzorunlu
  • membersnumberzorunlu
• POST/api/v1/matches/{id}/participants

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

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  İstek gövdesi

  • usernamestringisteğe bağlı
  • sidestring | nullisteğe bağlı

    Değerler: "A", "B"

  • guestNamestringisteğe bağlı

    2–40 characters

  Yanıttaki data

  • playerIdstringzorunlu
  • displayNamestringzorunlu
  • handlestring | nullzorunlu

    Null for guests

  • kindstringzorunlu

    Değerler: "registered", "guest"

  • sidestring | nullzorunlu

    Değerler: "A", "B"

  • rsvpstringzorunlu

    Değerler: "invited", "yes", "maybe", "no"

  • respondedAtstring | nullzorunlu
  • attendedbooleanzorunlu
  • isOrganizerbooleanzorunlu
  • positionsstring[]zorunlu

    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

    Değerler: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullzorunlu

    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

    • smallstringzorunlu

      128 px

    • mediumstringzorunlu

      512 px

    • largestringzorunlu

      1024 px

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

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

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu
  • playerIdstringzorunlu

  İstek gövdesi

  • sidestring | nullisteğe bağlı

    Değerler: "A", "B"

  • rsvpstringisteğe bağlı

    Guests only

    Değerler: "yes", "maybe", "no"

  Yanıttaki data

  • playerIdstringzorunlu
  • sidestring | nullzorunlu

    Değerler: "A", "B"

  • rsvpstringzorunlu

    Değerler: "invited", "yes", "maybe", "no"

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

  Take a player off the match (managers)

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu
  • playerIdstringzorunlu

  Yanıttaki data

  • playerIdstringzorunlu
  • removedbooleanzorunlu

    Değerler: true

• GET/api/v1/venues

  Search venues

  Oturum gerekir

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

  Alanları gösterAlanları gizle

  Sorgu parametreleri

  • qstringisteğe bağlı

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

  Yanıttaki data

  Tür: object[]

  Her öğenin alanları:

  • idstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • districtstring | nullzorunlu
  • addressstring | nullzorunlu
  • verifiedbooleanzorunlu

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]zorunlu
    • idstringzorunlu
    • namestringzorunlu

      e.g. "1. Saha"

    • indoorbooleanzorunlu
    • officialCamerabooleanzorunlu

      The pitch has the venue's own recorder: a match here can wait for its recording

• POST/api/v1/venues

  Add a venue

  Oturum gerekir

  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).

  Alanları gösterAlanları gizle

  İstek gövdesi

  • namestringzorunlu

    2–80 characters

  • citystringzorunlu

    2–40 characters

  • districtstring | nullisteğe bağlı

    Up to 40 characters

  • addressstring | nullisteğe bağlı

    Up to 160 characters

  • pitchNamestring | nullisteğe bağlı

    A first pitch, e.g. "1. Saha"

  • indoorbooleanisteğe bağlı

    Whether that first pitch is indoors

  Yanıttaki data

  • idstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • districtstring | nullzorunlu
  • addressstring | nullzorunlu
  • verifiedbooleanzorunlu

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]zorunlu
    • idstringzorunlu
    • namestringzorunlu

      e.g. "1. Saha"

    • indoorbooleanzorunlu
    • officialCamerabooleanzorunlu

      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)

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yanıttaki data

  Tür: object[]

  Her öğenin alanları:

  • idstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • districtstring | nullzorunlu
  • addressstring | nullzorunlu
  • verifiedbooleanzorunlu

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]zorunlu
    • idstringzorunlu
    • namestringzorunlu

      e.g. "1. Saha"

    • indoorbooleanzorunlu
    • officialCamerabooleanzorunlu

      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

  Oturum gerekir

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  Yanıttaki data

  • idstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • districtstring | nullzorunlu
  • addressstring | nullzorunlu
  • verifiedbooleanzorunlu

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]zorunlu
    • idstringzorunlu
    • namestringzorunlu

      e.g. "1. Saha"

    • indoorbooleanzorunlu
    • officialCamerabooleanzorunlu

      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

  Oturum gerekir

  Admins, or the person who added the venue while it is unverified (403 otherwise). 409 fields.name = taken for a duplicate name.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  İstek gövdesi

  • namestringzorunlu

    1–40 characters, unique within the venue

  • indoorbooleanisteğe bağlı

  Yanıttaki data

  • idstringzorunlu
  • namestringzorunlu
  • citystring | nullzorunlu
  • districtstring | nullzorunlu
  • addressstring | nullzorunlu
  • verifiedbooleanzorunlu

    Checked by an admin (a partner venue); show the verified mark

  • pitchesobject[]zorunlu
    • idstringzorunlu
    • namestringzorunlu

      e.g. "1. Saha"

    • indoorbooleanzorunlu
    • officialCamerabooleanzorunlu

      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

  Oturum gerekmez

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu
  • versionstringzorunlu

• GET/api/v1/venues/{id}/profile

  A venue's public page

  Oturum gerekmez

  Works signed out. 404 unless the venue has a login that is switched on (only those venues have a page).

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  Yanıttaki data

  • idstringzorunlu
  • slugstringzorunlu

    The page's address: /venues/<slug>

  • namestringzorunlu
  • verifiedbooleanzorunlu

    Checked by an admin; show the verified mark

  • districtstring | nullzorunlu
  • citystring | nullzorunlu
  • addressstring | nullzorunlu
  • descriptionstring | nullzorunlu

    Plain text, line breaks kept

  • logostring | nullzorunlu

    A path to the logo (immutable, cache it), or null

  • directionsobjectzorunlu

    Driving directions: to the coordinates when known, else a search for the name and address

    • googlestring (uri)zorunlu
    • applestring (uri)zorunlu
  • whatsappobject | nullzorunlu

    Only when the venue shows it

    • digitsstringzorunlu

      International, without +

    • linkstring (uri)zorunlu

      https://wa.me/<digits>

  • reservationsEnabledbooleanzorunlu

    The venue takes requests in the app; otherwise point people to WhatsApp

  • autoConfirmbooleanzorunlu

    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

  • slotMinutesnumberzorunlu

    Start times every 30 or 60 minutes from opening

    Değerler: 30, 60

  • openingHoursobjectzorunlu

    Istanbul clock; null: closed

    • monobject | nullzorunlu
      • openstringzorunlu

        "10:00"

      • closestringzorunlu

        "01:00"; at or before open means after midnight

    • tueobject | nullzorunlu
      • openstringzorunlu

        "10:00"

      • closestringzorunlu

        "01:00"; at or before open means after midnight

    • wedobject | nullzorunlu
      • openstringzorunlu

        "10:00"

      • closestringzorunlu

        "01:00"; at or before open means after midnight

    • thuobject | nullzorunlu
      • openstringzorunlu

        "10:00"

      • closestringzorunlu

        "01:00"; at or before open means after midnight

    • friobject | nullzorunlu
      • openstringzorunlu

        "10:00"

      • closestringzorunlu

        "01:00"; at or before open means after midnight

    • satobject | nullzorunlu
      • openstringzorunlu

        "10:00"

      • closestringzorunlu

        "01:00"; at or before open means after midnight

    • sunobject | nullzorunlu
      • openstringzorunlu

        "10:00"

      • closestringzorunlu

        "01:00"; at or before open means after midnight

  • todaystringzorunlu

    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[]zorunlu
    • idstringzorunlu
    • namestringzorunlu
    • indoorbooleanzorunlu
• GET/api/v1/venues/{id}/availability

  Free times on a venue day, per pitch

  Oturum gerekmez

  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.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  Sorgu parametreleri

  • datestringisteğe bağlı

    The venue day, YYYY-MM-DD (default: the venue day open now); from yesterday up to 31 days ahead

  • durationMinstringisteğe bağlı

    60 (default), 90 or 120

  Yanıttaki data

  • datestringzorunlu
  • durationMinnumberzorunlu
  • slotMinutesnumberzorunlu
  • hoursobject | nullzorunlu

    That venue day's hours; null when closed

    • openstringzorunlu

      "10:00"

    • closestringzorunlu

      "01:00"; at or before open means after midnight

  • leadMinutesnumberzorunlu

    How long before its start a time can still be asked for: 150 minutes, or 30 for someone the venue confirms at once

  • pitchesobject[]zorunlu
    • idstringzorunlu
    • namestringzorunlu
    • slotsobject[]zorunlu
      • timestringzorunlu

        Istanbul wall clock, "21:00"

      • datestringzorunlu

        The calendar date the time falls on (the next date after midnight)

      • startsAtstringzorunlu

        ISO 8601 (UTC)

      • nextDaybooleanzorunlu

        After the venue day's midnight: show it as "Friday night 01:00 (Saturday 9 November)"

      • statestringzorunlu

        requested: someone asked and the venue has not answered; it can still be asked for

        Değerler: "free", "requested", "taken", "soon", "tooFar"

• POST/api/v1/venues/{id}/reservations

  Ask a venue for a booking

  Oturum gerekir

  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).

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  İstek gövdesi

  • pitchIdstringzorunlu
  • datestringzorunlu

    The venue day, YYYY-MM-DD

  • timestringzorunlu

    One of that day's start times (a slot's time), HH:MM

  • durationMinnumberzorunlu

    Değerler: 60, 90, 120

  • teamIdstring | nullisteğe bağlı

    One of your teams: side A of the match made on confirmation

  • notestring | nullisteğe bağlı

    Up to 300 characters, for the venue

  • phonestring | nullisteğe bağlı

    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…"

  • wantsMatchbooleanisteğe bağlı

    Default true: when the venue confirms, your match is made (this venue, pitch and time, your team on side A) and linked

  • matchIdstring | nullisteğe bağlı

    Instead: one of your own matches at exactly this time with no booking yet, to link

  Yanıttaki data

  • idstringzorunlu
  • venueobjectzorunlu
    • idstringzorunlu
    • namestringzorunlu
    • verifiedbooleanzorunlu
    • slugstring | nullzorunlu

      Null once the venue's page is gone

  • pitchobjectzorunlu
    • idstringzorunlu
    • namestringzorunlu
  • startsAtstringzorunlu
  • endsAtstringzorunlu
  • durationMinnumberzorunlu
  • venueDatestringzorunlu

    The venue day it belongs to

  • nextDaybooleanzorunlu
  • statusstringzorunlu

    lapsed: the venue did not answer by 2 hours before the start

    Değerler: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullzorunlu

    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 | nullzorunlu

    Değerler: "person", "venue"

  • teamobject | nullzorunlu
    • idstringzorunlu
    • namestringzorunlu
  • matchobject | nullzorunlu

    The match made from (or linked to) the booking, while it is not cancelled

    • idstringzorunlu
  • wantsMatchbooleanzorunlu
  • canCancelbooleanzorunlu
  • canMakeMatchbooleanzorunlu

    Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

• GET/api/v1/reservations

  Your bookings

  Oturum gerekir

  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.

  Alanları gösterAlanları gizle

  Yanıttaki data

  • upcomingobject[]zorunlu
    • idstringzorunlu
    • venueobjectzorunlu
      • idstringzorunlu
      • namestringzorunlu
      • verifiedbooleanzorunlu
      • slugstring | nullzorunlu

        Null once the venue's page is gone

    • pitchobjectzorunlu
      • idstringzorunlu
      • namestringzorunlu
    • startsAtstringzorunlu
    • endsAtstringzorunlu
    • durationMinnumberzorunlu
    • venueDatestringzorunlu

      The venue day it belongs to

    • nextDaybooleanzorunlu
    • statusstringzorunlu

      lapsed: the venue did not answer by 2 hours before the start

      Değerler: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullzorunlu

      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 | nullzorunlu

      Değerler: "person", "venue"

    • teamobject | nullzorunlu
      • idstringzorunlu
      • namestringzorunlu
    • matchobject | nullzorunlu

      The match made from (or linked to) the booking, while it is not cancelled

      • idstringzorunlu
    • wantsMatchbooleanzorunlu
    • canCancelbooleanzorunlu
    • canMakeMatchbooleanzorunlu

      Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId

  • pastobject[]zorunlu
    • idstringzorunlu
    • venueobjectzorunlu
      • idstringzorunlu
      • namestringzorunlu
      • verifiedbooleanzorunlu
      • slugstring | nullzorunlu

        Null once the venue's page is gone

    • pitchobjectzorunlu
      • idstringzorunlu
      • namestringzorunlu
    • startsAtstringzorunlu
    • endsAtstringzorunlu
    • durationMinnumberzorunlu
    • venueDatestringzorunlu

      The venue day it belongs to

    • nextDaybooleanzorunlu
    • statusstringzorunlu

      lapsed: the venue did not answer by 2 hours before the start

      Değerler: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullzorunlu

      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 | nullzorunlu

      Değerler: "person", "venue"

    • teamobject | nullzorunlu
      • idstringzorunlu
      • namestringzorunlu
    • matchobject | nullzorunlu

      The match made from (or linked to) the booking, while it is not cancelled

      • idstringzorunlu
    • wantsMatchbooleanzorunlu
    • canCancelbooleanzorunlu
    • canMakeMatchbooleanzorunlu

      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

  Oturum gerekir

  Waiting or confirmed, before it starts; the time is free again. 404 for someone else's booking; 409 fields.form: notActive, started.

  Alanları gösterAlanları gizle

  Yol parametreleri

  • idstringzorunlu

  Yanıttaki data

  • idstringzorunlu
  • venueobjectzorunlu
    • idstringzorunlu
    • namestringzorunlu
    • verifiedbooleanzorunlu
    • slugstring | nullzorunlu

      Null once the venue's page is gone

  • pitchobjectzorunlu
    • idstringzorunlu
    • namestringzorunlu
  • startsAtstringzorunlu
  • endsAtstringzorunlu
  • durationMinnumberzorunlu
  • venueDatestringzorunlu

    The venue day it belongs to

  • nextDaybooleanzorunlu
  • statusstringzorunlu

    lapsed: the venue did not answer by 2 hours before the start

    Değerler: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullzorunlu

    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 | nullzorunlu

    Değerler: "person", "venue"

  • teamobject | nullzorunlu
    • idstringzorunlu
    • namestringzorunlu
  • matchobject | nullzorunlu

    The match made from (or linked to) the booking, while it is not cancelled

    • idstringzorunlu
  • wantsMatchbooleanzorunlu
  • canCancelbooleanzorunlu
  • canMakeMatchbooleanzorunlu

    Confirmed, not started and without a match: POST /api/v1/matches with its time, place and reservationId