Developers

Endpoints live under https://akilli.futbol/api/v1; requests and responses are JSON.

The whole reference is also an OpenAPI 3.1 document you can load into Postman, Insomnia or a client generator.

Endpoint summaries and notes come straight from the OpenAPI document.

118 endpoints in 17 sections.

1. 1

   Create an account or sign in: send the username and password as JSON to POST /api/auth/sign-up/username or 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

   Keep the signed token from the set-auth-token response header somewhere safe on the device. Only that token works as a bearer token: the token in the body is the raw session token and is refused.

   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

   Send Authorization: Bearer <token> with every request.

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

In a browser the web session cookie works too. A wrong password and an unknown username get the same error (401); suspended accounts get 403 BANNED_USER. Sign-in attempts are limited per IP and per username (429).

To sign out, send POST /api/auth/sign-out; to sign out every other device, POST /api/auth/revoke-other-sessions. Neither needs a body. A session ends only when the call answers 200, so check the status. Changing the password with POST /api/auth/change-password ends every session, this one too, and answers with a new token in set-auth-token: keep it in place of the old one.

Successful responses carry the result in data. Errors carry a code, a readable message and, where it helps, error codes per field (fields) in error.

{
  "data": { … }
}

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

Error codes

• 401UNAUTHENTICATEDNo session, or the token is not valid: sign in again.
• 403FORBIDDENYou are not allowed to do this.
• 404NOT_FOUNDIt does not exist, or you cannot see it.
• 409CONFLICTThe request clashes with the current state; fields says why.
• 422INVALIDThe body or some fields are not valid; fields has a code per field.
• 429RATE_LIMITEDToo many requests: wait a little and try again.
• 500INTERNALSomething went wrong on the server: try again later.

An unknown path under /api/v1 answers 404 NOT_FOUND in this shape too; a method a path does not offer gets 405 with an empty body.

The endpoints under /api/auth belong to Better Auth: their responses come without the data envelope, and their errors carry code and message.

• GET/api/v1/sign-up

  Whether new accounts can be made

  No session needed

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

  Show the fieldsHide the fields

  data in the response

  • openbooleanrequired

    false during the private beta: only sign-in

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

  Create an account and sign in

  No session needed

  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.

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Request body

  • displayNamestringrequired

    2–40 characters

  • usernamestringrequired

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

  • passwordstringrequired

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

  • positionsstring[]optional

    Values: "goalkeeper", "defender", "midfielder", "forward"

  • adultbooleanrequired

    Values: true

  • privacyNoticebooleanrequired

    Values: true

  • termsbooleanrequired

    Values: true

  • localestringrequired

    Values: "tr", "en", "ru", "ar"

  Response body

  • userobjectrequired
    • idstringrequired
    • usernamestringrequired
• POST/api/auth/sign-in/username

  Sign in

  No session needed

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

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Request body

  • usernamestringrequired
  • passwordstringrequired
  • rememberMebooleanoptional

  Response body

  • redirectbooleanrequired

    Always false

  • tokenstringrequired

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

  • userobjectrequired
    • idstringrequired
    • usernamestringrequired

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

    • displayUsernamestringrequired
    • namestringrequired

      The display name

    • emailstringrequired

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

    • emailVerifiedbooleanrequired
    • imagestring | nullrequired
    • rolestring | nullrequired

      "admin" or "user"

    • bannedboolean | nullrequired
    • banReasonstring | nullrequired
    • banExpiresstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
• POST/api/auth/sign-in/apple

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

  No session needed

  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.

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Request body

  • identityTokenstringrequired

    The identity token from Sign in with Apple on the device

  • noncestringrequired

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

  • authorizationCodestringoptional

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

  • givenNamestringoptional

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

  • familyNamestringoptional
  • usernamestringoptional

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

  • displayNamestringoptional

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

  • positionsstring[]optional

    Values: "goalkeeper", "defender", "midfielder", "forward"

  • adultbooleanoptional

    For a new account: true

  • privacyNoticebooleanoptional

    For a new account: true

  • termsbooleanoptional

    For a new account: true

  • localestringrequired

    Values: "tr", "en", "ru", "ar"

  Response body

  • userobjectrequired
    • idstringrequired
    • usernamestringrequired
  • createdbooleanrequired

    true when this call made the account

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

  Check whether a username is free

  No session needed

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

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Request body

  • usernamestringrequired

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

  Response body

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

  Sign out (ends this session)

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

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Request body

  No fields.

  Response body

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

  The current session and user

  Needs a session

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

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Response body

  • sessionobjectrequired
    • idstringrequired
    • userIdstringrequired
    • tokenstringrequired

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

    • expiresAtstringrequired

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

    • createdAtstringrequired
    • updatedAtstringrequired
    • ipAddressstring | nullrequired
    • userAgentstring | nullrequired
    • impersonatedBystring | nullrequired
  • userobjectrequired
    • idstringrequired
    • usernamestringrequired

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

    • displayUsernamestringrequired
    • namestringrequired

      The display name

    • emailstringrequired

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

    • emailVerifiedbooleanrequired
    • imagestring | nullrequired
    • rolestring | nullrequired

      "admin" or "user"

    • bannedboolean | nullrequired
    • banReasonstring | nullrequired
    • banExpiresstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
• POST/api/auth/change-password

  Change the password

  Needs a session

  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.

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Request body

  • currentPasswordstringrequired
  • newPasswordstringrequired

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

  Response body

  • tokenstringrequired

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

  • userobjectrequired
    • idstringrequired
    • usernamestringrequired

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

    • displayUsernamestringrequired
    • namestringrequired

      The display name

    • emailstringrequired

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

    • emailVerifiedbooleanrequired
    • imagestring | nullrequired
    • rolestring | nullrequired

      "admin" or "user"

    • bannedboolean | nullrequired
    • banReasonstring | nullrequired
    • banExpiresstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
• POST/api/auth/revoke-other-sessions

  Sign out every other device

  Needs a session

  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.

  A Better Auth endpoint: the response comes without the data envelope.

  Show the fieldsHide the fields

  Request body

  No fields.

  Response body

  • statusbooleanrequired

• GET/api/v1/me

  Your profile settings

  Needs a session

  Show the fieldsHide the fields

  data in the response

  • idstringrequired

    The player id

  • userIdstringrequired
  • usernamestringrequired

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

  • handlestringrequired
  • displayNamestringrequired
  • positionsstring[]required

    Values: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullrequired

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

    • smallstringrequired

      128 px

    • mediumstringrequired

      512 px

    • largestringrequired

      1024 px

  • visibilitystringrequired

    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

    Values: "public", "teammates", "private"

  • rolestring | nullrequired

    "admin" or "user"

  • activeSessionsintegerrequired

    Signed-in devices, this one included

  • appleLinkedbooleanrequired

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

  • hasPasswordbooleanrequired

    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

  Needs a session

  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.

  Show the fieldsHide the fields

  Request body

  • displayNamestringoptional

    at least 1 characters

  • positionsstring[]optional

    Values: "goalkeeper", "defender", "midfielder", "forward"

  • visibilitystringoptional

    Values: "public", "teammates", "private"

  data in the response

  • idstringrequired

    The player id

  • userIdstringrequired
  • usernamestringrequired

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

  • handlestringrequired
  • displayNamestringrequired
  • positionsstring[]required

    Values: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullrequired

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

    • smallstringrequired

      128 px

    • mediumstringrequired

      512 px

    • largestringrequired

      1024 px

  • visibilitystringrequired

    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

    Values: "public", "teammates", "private"

  • rolestring | nullrequired

    "admin" or "user"

  • activeSessionsintegerrequired

    Signed-in devices, this one included

  • appleLinkedbooleanrequired

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

  • hasPasswordbooleanrequired

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

• DELETE/api/v1/me

  Delete your account

  Needs a session

  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.

  Show the fieldsHide the fields

  Request body

  • confirmstringrequired

    Your username, as a confirmation (any case)

  data in the response

  • deletedbooleanrequired

    Values: true

• POST/api/v1/me/apple

  Link Sign in with Apple to your account

  Needs a session

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

  Show the fieldsHide the fields

  Request body

  • identityTokenstringrequired

    The identity token from Sign in with Apple on the device

  • noncestringrequired

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

  • authorizationCodestringoptional

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

  data in the response

  • linkedbooleanrequired

    Values: true

• DELETE/api/v1/me/apple

  Unlink Sign in with Apple

  Needs a session

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

  Show the fieldsHide the fields

  data in the response

  • linkedbooleanrequired

    Values: false

• POST/api/v1/me/devices

  Register this phone for pushes

  Needs a session

  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.

  Show the fieldsHide the fields

  Request body

  • tokenstringrequired

    The APNs device token as hex (64 characters today)

  • platformstringrequired

    Values: "ios"

  • environmentstringrequired

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

    Values: "sandbox", "production"

  • bundleIdstringrequired

    The app's bundle identifier

    1–200 characters

  • localestringrequired

    The language pushes are written in

    Values: "tr", "en", "ru", "ar"

  data in the response

  • idstringrequired

    The device id

  • tokenstringrequired

    The token as stored: lower-case hex

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

  Stop pushes to one of your devices

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • tokenstringrequired

  data in the response

  • removedbooleanrequired

    False when the token was not registered to you

• GET/api/v1/me/photo

  Your profile photo

  Needs a session

  Show the fieldsHide the fields

  data in the response

  • photoobject | nullrequired

    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

    • smallstringrequired

      128 px

    • mediumstringrequired

      512 px

    • largestringrequired

      1024 px

• PUT/api/v1/me/photo

  Upload or replace your profile photo

  Needs a session

  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.

  Show the fieldsHide the fields

  data in the response

  • photoobject | nullrequired

    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

    • smallstringrequired

      128 px

    • mediumstringrequired

      512 px

    • largestringrequired

      1024 px

• DELETE/api/v1/me/photo

  Remove your profile photo

  Needs a session

  Your initials show again. Fine without a photo.

  Show the fieldsHide the fields

  data in the response

  • photoobject | nullrequired

    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

    • smallstringrequired

      128 px

    • mediumstringrequired

      512 px

    • largestringrequired

      1024 px

• GET/api/v1/teams

  Teams the caller plays for (archived teams left out)

  Needs a session

  Show the fieldsHide the fields

  data in the response

  Type: object[]

  Fields of each item:

  • idstring (uuid)required
  • slugstringrequired

    URL slug, e.g. kartallar-7k2m

  • namestringrequired
  • citystring | nullrequired
  • kitHomeHexstringrequired

    #rrggbb, lower-case

  • kitAwayHexstring | nullrequired

    #rrggbb, lower-case

  • crestobject | nullrequired

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

    • shapestringrequired

      Values: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringrequired
    • secondarystringrequired
    • letterstringrequired
    • patternstringoptional

      Values: "plain", "split", "stripes", "sash", "chevron", "hoops"Default: "plain"

    • detailstringoptional

      Values: "none", "star", "ball", "crown", "laurel", "wings"Default: "none"

  • rolestringrequired

    The caller's role in the team

    Values: "captain", "co_captain", "member"

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

  Needs a session

  Show the fieldsHide the fields

  Request body

  • namestringrequired

    2–40 characters

  • citystring | nulloptional

    at most 60 characters

  • kitHomeHexstringrequired
  • kitAwayHexstring | nulloptional
  • crestobject | nulloptional
    • shapestringrequired

      Values: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringrequired
    • secondarystringrequired
    • letterstringrequired
    • patternstringoptional

      Values: "plain", "split", "stripes", "sash", "chevron", "hoops"Default: "plain"

    • detailstringoptional

      Values: "none", "star", "ball", "crown", "laurel", "wings"Default: "none"

  data in the response

  • idstring (uuid)required
  • slugstringrequired
  • namestringrequired
  • citystring | nullrequired
  • kitHomeHexstringrequired

    #rrggbb, lower-case

  • kitAwayHexstring | nullrequired

    #rrggbb, lower-case

  • crestobject | nullrequired
    • shapestringrequired

      Values: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringrequired
    • secondarystringrequired
    • letterstringrequired
    • patternstringoptional

      Values: "plain", "split", "stripes", "sash", "chevron", "hoops"Default: "plain"

    • detailstringoptional

      Values: "none", "star", "ball", "crown", "laurel", "wings"Default: "none"

  • archivedAtstring (date-time) | nullrequired
  • createdAtstring (date-time)required
  • memberCountintegerrequired
  • viewerobjectrequired
    • rolestring | nullrequired

      Null for an admin who is not a member

      Values: "captain", "co_captain", "member"

    • canEditbooleanrequired
    • canRotateCodebooleanrequired
    • canArchivebooleanrequired
    • mustHandOverbooleanrequired

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

    • onlyMemberbooleanrequired

      Leaving would archive the team

  • codestring | nullrequired

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullrequired

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

  • membersobject[]required

    Captains first, then co-captains, then players

    • playerIdstring (uuid)required
    • displayNamestringrequired
    • handlestring | nullrequired

      Null for guests

    • kindstringrequired

      Values: "registered", "guest"

    • positionsstring[]required

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

      Values: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullrequired

      Follows the member's visibility, like the positions

      • smallstringrequired

        128 px

      • mediumstringrequired

        512 px

      • largestringrequired

        1024 px

    • rolestringrequired

      Values: "captain", "co_captain", "member"

    • numberinteger | nullrequired
    • joinedAtstring (date-time)required
    • isViewerbooleanrequired
    • canobjectrequired
      • rolesstring[]required

        Roles the caller may give this member

        Values: "captain", "co_captain", "member"

      • removebooleanrequired
  • matchesobjectrequired

    Up to 5 each

    • upcomingobject[]required
      • idstring (uuid)required
      • startsAtstring (date-time)required
      • statusstringrequired

        Values: "planned", "played", "cancelled"

      • titlestring | nullrequired
      • venueobject | nullrequired
        • namestringrequired
        • verifiedbooleanrequired
      • sidesobject[]required
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsinteger | nullrequired
        • oursbooleanrequired

          This team plays on this side

    • recentobject[]required
      • idstring (uuid)required
      • startsAtstring (date-time)required
      • statusstringrequired

        Values: "planned", "played", "cancelled"

      • titlestring | nullrequired
      • venueobject | nullrequired
        • namestringrequired
        • verifiedbooleanrequired
      • sidesobject[]required
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsinteger | nullrequired
        • oursbooleanrequired

          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.

  Needs a session

  Show the fieldsHide the fields

  Path parameters

  • slugstringrequired

  data in the response

  • idstring (uuid)required
  • slugstringrequired
  • namestringrequired
  • citystring | nullrequired
  • kitHomeHexstringrequired

    #rrggbb, lower-case

  • kitAwayHexstring | nullrequired

    #rrggbb, lower-case

  • crestobject | nullrequired
    • shapestringrequired

      Values: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringrequired
    • secondarystringrequired
    • letterstringrequired
    • patternstringoptional

      Values: "plain", "split", "stripes", "sash", "chevron", "hoops"Default: "plain"

    • detailstringoptional

      Values: "none", "star", "ball", "crown", "laurel", "wings"Default: "none"

  • archivedAtstring (date-time) | nullrequired
  • createdAtstring (date-time)required
  • memberCountintegerrequired
  • viewerobjectrequired
    • rolestring | nullrequired

      Null for an admin who is not a member

      Values: "captain", "co_captain", "member"

    • canEditbooleanrequired
    • canRotateCodebooleanrequired
    • canArchivebooleanrequired
    • mustHandOverbooleanrequired

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

    • onlyMemberbooleanrequired

      Leaving would archive the team

  • codestring | nullrequired

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullrequired

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

  • membersobject[]required

    Captains first, then co-captains, then players

    • playerIdstring (uuid)required
    • displayNamestringrequired
    • handlestring | nullrequired

      Null for guests

    • kindstringrequired

      Values: "registered", "guest"

    • positionsstring[]required

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

      Values: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullrequired

      Follows the member's visibility, like the positions

      • smallstringrequired

        128 px

      • mediumstringrequired

        512 px

      • largestringrequired

        1024 px

    • rolestringrequired

      Values: "captain", "co_captain", "member"

    • numberinteger | nullrequired
    • joinedAtstring (date-time)required
    • isViewerbooleanrequired
    • canobjectrequired
      • rolesstring[]required

        Roles the caller may give this member

        Values: "captain", "co_captain", "member"

      • removebooleanrequired
  • matchesobjectrequired

    Up to 5 each

    • upcomingobject[]required
      • idstring (uuid)required
      • startsAtstring (date-time)required
      • statusstringrequired

        Values: "planned", "played", "cancelled"

      • titlestring | nullrequired
      • venueobject | nullrequired
        • namestringrequired
        • verifiedbooleanrequired
      • sidesobject[]required
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsinteger | nullrequired
        • oursbooleanrequired

          This team plays on this side

    • recentobject[]required
      • idstring (uuid)required
      • startsAtstring (date-time)required
      • statusstringrequired

        Values: "planned", "played", "cancelled"

      • titlestring | nullrequired
      • venueobject | nullrequired
        • namestringrequired
        • verifiedbooleanrequired
      • sidesobject[]required
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsinteger | nullrequired
        • oursbooleanrequired

          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.

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • slugstringrequired

  Request body

  • namestringoptional

    2–40 characters

  • citystring | nulloptional

    at most 60 characters

  • kitHomeHexstringoptional
  • kitAwayHexstring | nulloptional
  • crestobject | nulloptional
    • shapestringrequired

      Values: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringrequired
    • secondarystringrequired
    • letterstringrequired
    • patternstringoptional

      Values: "plain", "split", "stripes", "sash", "chevron", "hoops"Default: "plain"

    • detailstringoptional

      Values: "none", "star", "ball", "crown", "laurel", "wings"Default: "none"

  data in the response

  • idstring (uuid)required
  • slugstringrequired
  • namestringrequired
  • citystring | nullrequired
  • kitHomeHexstringrequired

    #rrggbb, lower-case

  • kitAwayHexstring | nullrequired

    #rrggbb, lower-case

  • crestobject | nullrequired
    • shapestringrequired

      Values: "shield", "round", "rounded", "diamond", "hexagon", "pennant", "arched", "oval", "crest", "octagon", "ticket", "star"

    • primarystringrequired
    • secondarystringrequired
    • letterstringrequired
    • patternstringoptional

      Values: "plain", "split", "stripes", "sash", "chevron", "hoops"Default: "plain"

    • detailstringoptional

      Values: "none", "star", "ball", "crown", "laurel", "wings"Default: "none"

  • archivedAtstring (date-time) | nullrequired
  • createdAtstring (date-time)required
  • memberCountintegerrequired
  • viewerobjectrequired
    • rolestring | nullrequired

      Null for an admin who is not a member

      Values: "captain", "co_captain", "member"

    • canEditbooleanrequired
    • canRotateCodebooleanrequired
    • canArchivebooleanrequired
    • mustHandOverbooleanrequired

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

    • onlyMemberbooleanrequired

      Leaving would archive the team

  • codestring | nullrequired

    The live 6-letter invite code; null once archived

  • inviteUrlstring (uri) | nullrequired

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

  • membersobject[]required

    Captains first, then co-captains, then players

    • playerIdstring (uuid)required
    • displayNamestringrequired
    • handlestring | nullrequired

      Null for guests

    • kindstringrequired

      Values: "registered", "guest"

    • positionsstring[]required

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

      Values: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullrequired

      Follows the member's visibility, like the positions

      • smallstringrequired

        128 px

      • mediumstringrequired

        512 px

      • largestringrequired

        1024 px

    • rolestringrequired

      Values: "captain", "co_captain", "member"

    • numberinteger | nullrequired
    • joinedAtstring (date-time)required
    • isViewerbooleanrequired
    • canobjectrequired
      • rolesstring[]required

        Roles the caller may give this member

        Values: "captain", "co_captain", "member"

      • removebooleanrequired
  • matchesobjectrequired

    Up to 5 each

    • upcomingobject[]required
      • idstring (uuid)required
      • startsAtstring (date-time)required
      • statusstringrequired

        Values: "planned", "played", "cancelled"

      • titlestring | nullrequired
      • venueobject | nullrequired
        • namestringrequired
        • verifiedbooleanrequired
      • sidesobject[]required
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsinteger | nullrequired
        • oursbooleanrequired

          This team plays on this side

    • recentobject[]required
      • idstring (uuid)required
      • startsAtstring (date-time)required
      • statusstringrequired

        Values: "planned", "played", "cancelled"

      • titlestring | nullrequired
      • venueobject | nullrequired
        • namestringrequired
        • verifiedbooleanrequired
      • sidesobject[]required
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsinteger | nullrequired
        • oursbooleanrequired

          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

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • slugstringrequired

  data in the response

  • codestringrequired
  • inviteUrlstring (uri)required
• 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.

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • slugstringrequired
  • playerIdstringrequired

  Request body

  • rolestringrequired

    Values: "captain", "co_captain", "member"

  data in the response

  • playerIdstring (uuid)required
  • rolestringrequired

    Values: "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.

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • slugstringrequired
  • playerIdstringrequired

  data in the response

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

  Needs a session

  Show the fieldsHide the fields

  Path parameters

  • slugstringrequired

  data in the response

  • archivedbooleanrequired

    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

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • slugstringrequired

  data in the response

  • archivedAtstring (date-time)required

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

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

  No session needed

  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.

  Show the fieldsHide the fields

  Path parameters

  • codestringrequired

  data in the response

  • kindstringrequired

    Values: "team", "match"

  • codestringrequired

    The canonical code: six capital letters

  • teamobjectoptional
    • idstringrequired
    • slugstringrequired
    • namestringrequired
    • citystring | nullrequired
    • kitHomeHexstringrequired

      #rrggbb

    • kitAwayHexstring | nullrequired
    • memberCountintegerrequired
    • captainobject | nullrequired

      Null when signed out

      • idstringrequired
      • displayNamestringrequired
      • handlestring | nullrequired
      • photoobject | nullrequired

        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

        • smallstringrequired

          128 px

        • mediumstringrequired

          512 px

        • largestringrequired

          1024 px

    • archivedbooleanrequired

      Closed teams take no new members

  • viewerobjectrequired
    • signedInbooleanrequired
    • memberbooleanrequired
    • rolestring | nullrequired

      Values: "captain", "co_captain", "member"

    • canJoinbooleanrequired
  • matchobjectoptional
    • idstringrequired
    • kindstringrequired

      Values: "fixture", "pickup"

    • statusstringrequired

      Values: "planned", "played", "cancelled"

    • statestringrequired

      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.

      Values: "open", "cancelled", "finished"

    • titlestring | nullrequired
    • startsAtstringrequired

      ISO 8601

    • durationMinintegerrequired
    • venueobject | nullrequired
      • namestringrequired
      • citystring | nullrequired
      • districtstring | nullrequired
      • addressstring | nullrequired
      • verifiedbooleanrequired
    • pitchobject | nullrequired
      • namestringrequired
      • indoorbooleanrequired
    • sidesobject[]required
      • sidestringrequired

        Values: "A", "B"

      • labelstringrequired
      • goalsinteger | nullrequired
      • teamobject | nullrequired
        • slugstringrequired
        • namestringrequired
    • comingobjectrequired

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

      • Aintegerrequired
      • Bintegerrequired
      • noneintegerrequired
      • totalintegerrequired
      • maybeintegerrequired
    • playersobject[]required

      Who said yes or maybe; empty when signed out

      • idstringrequired
      • displayNamestringrequired
      • sidestring | nullrequired

        Values: "A", "B"

      • rsvpstringrequired

        Values: "yes", "maybe"

      • youbooleanrequired
      • photoobject | nullrequired

        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

        • smallstringrequired

          128 px

        • mediumstringrequired

          512 px

        • largestringrequired

          1024 px

    • organizerobject | nullrequired

      Null when signed out

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

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

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • codestringrequired

  Request body

  • rsvpstringoptional

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

    Values: "yes", "maybe", "no"

  data in the response

  • kindstringrequired

    Values: "team", "match"

  • teamobjectoptional
    • idstringrequired
    • slugstringrequired
    • namestringrequired
  • rolestringoptional

    Values: "captain", "co_captain", "member"

  • alreadyMemberbooleanoptional
  • matchobjectoptional
    • idstringrequired
  • participantobjectoptional
    • rsvpstringrequired

      Values: "invited", "yes", "maybe", "no"

    • sidestring | nullrequired

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

      Values: "A", "B"

    • respondedAtstring | nullrequired

• GET/api/v1/matches

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

  Needs a session

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

  Show the fieldsHide the fields

  data in the response

  • upcomingobject[]required
    • idstringrequired
    • titlestring | nullrequired
    • kindstringrequired

      Values: "pickup", "fixture"

    • statusstringrequired

      Values: "planned", "played", "cancelled"

    • startsAtstringrequired

      ISO 8601 (UTC)

    • durationMinnumberrequired
    • scoreStatestringrequired

      Values: "none", "entered", "confirmed"

    • venueobject | nullrequired
      • namestringrequired
      • districtstring | nullrequired
      • citystring | nullrequired
      • addressstring | nullrequired
      • verifiedbooleanrequired
      • latitudenumber | nullrequired

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

      • longitudenumber | nullrequired

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

    • pitchobject | nullrequired
      • namestringrequired
    • sidesobjectrequired
      • Aobjectrequired
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsnumber | nullrequired

          Null until the score is entered

        • bibHexstring | nullrequired
        • teamIdstring | nullrequired
        • teamNamestring | nullrequired
      • Bobjectrequired
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsnumber | nullrequired

          Null until the score is entered

        • bibHexstring | nullrequired
        • teamIdstring | nullrequired
        • teamNamestring | nullrequired
    • comingnumberrequired

      How many said "yes"

    • meobjectrequired
      • rsvpstring | nullrequired

        Values: "invited", "yes", "maybe", "no"

      • sidestring | nullrequired

        Values: "A", "B"

      • isOrganizerbooleanrequired
    • canRespondbooleanrequired
  • pastobject[]required
    • idstringrequired
    • titlestring | nullrequired
    • kindstringrequired

      Values: "pickup", "fixture"

    • statusstringrequired

      Values: "planned", "played", "cancelled"

    • startsAtstringrequired

      ISO 8601 (UTC)

    • durationMinnumberrequired
    • scoreStatestringrequired

      Values: "none", "entered", "confirmed"

    • venueobject | nullrequired
      • namestringrequired
      • districtstring | nullrequired
      • citystring | nullrequired
      • addressstring | nullrequired
      • verifiedbooleanrequired
      • latitudenumber | nullrequired

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

      • longitudenumber | nullrequired

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

    • pitchobject | nullrequired
      • namestringrequired
    • sidesobjectrequired
      • Aobjectrequired
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsnumber | nullrequired

          Null until the score is entered

        • bibHexstring | nullrequired
        • teamIdstring | nullrequired
        • teamNamestring | nullrequired
      • Bobjectrequired
        • sidestringrequired

          Values: "A", "B"

        • labelstringrequired
        • goalsnumber | nullrequired

          Null until the score is entered

        • bibHexstring | nullrequired
        • teamIdstring | nullrequired
        • teamNamestring | nullrequired
    • comingnumberrequired

      How many said "yes"

    • meobjectrequired
      • rsvpstring | nullrequired

        Values: "invited", "yes", "maybe", "no"

      • sidestring | nullrequired

        Values: "A", "B"

      • isOrganizerbooleanrequired
    • canRespondbooleanrequired
• POST/api/v1/matches

  Create a match

  Needs a session

  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.

  Show the fieldsHide the fields

  Request body

  • titlestring | nulloptional

    Up to 60 characters

  • kindstringoptional

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

    Values: "pickup", "fixture"

  • datestringoptional

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

  • timestringoptional

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

  • startsAtstringoptional

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

  • durationMinnumberoptional

    Default 60

    Values: 60, 90, 120

  • venueIdstring | nulloptional
  • pitchIdstring | nulloptional

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

  • recordingstringoptional

    official only on a pitch with an official camera

    Values: "upload", "official"

  • sidesobjectoptional

    Default labels "Turuncular" and "Maviler"

    • Aobjectrequired
      • labelstringrequired

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

      • teamIdstring | nulloptional

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

      • bibHexstring | nulloptional

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

    • Bobjectrequired
      • labelstringrequired

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

      • teamIdstring | nulloptional

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

      • bibHexstring | nulloptional

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

  • invitedTeamIdsstring[]optional

    Your teams whose members all get an invitation

  • notesstring | nulloptional

    Up to 500 characters

  • alreadyPlayedbooleanoptional

    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.

  • reservationIdstringoptional

    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 in the response

  • idstringrequired
  • codestringrequired
  • inviteUrlstring (uri)required

    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

  Needs a session

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  data in the response

  • idstringrequired
  • titlestring | nullrequired
  • kindstringrequired

    Values: "pickup", "fixture"

  • statusstringrequired

    Values: "planned", "played", "cancelled"

  • startsAtstringrequired
  • endsAtstringrequired
  • durationMinnumberrequired
  • recordingstringrequired

    Values: "upload", "official"

  • scoreStatestringrequired

    Values: "none", "entered", "confirmed"

  • notesstring | nullrequired
  • cancelledAtstring | nullrequired
  • organizerobjectrequired
    • playerIdstringrequired
    • displayNamestringrequired
    • handlestring | nullrequired
  • venueobject | nullrequired
    • idstringrequired
    • namestringrequired
    • citystring | nullrequired
    • districtstring | nullrequired
    • addressstring | nullrequired
    • verifiedbooleanrequired
    • slugstring | nullrequired

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

    • latitudenumber | nullrequired

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

    • longitudenumber | nullrequired

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

  • pitchobject | nullrequired
    • idstringrequired
    • namestringrequired
    • indoorbooleanrequired
    • officialCamerabooleanrequired
  • cameraobject | nullrequired

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

    • idstringrequired
    • labelstringrequired
    • officialbooleanrequired
  • sidesobjectrequired
    • Aobjectrequired
      • sidestringrequired

        Values: "A", "B"

      • labelstringrequired
      • goalsnumber | nullrequired

        Null until the score is entered

      • bibHexstring | nullrequired
      • teamIdstring | nullrequired
      • teamNamestring | nullrequired
    • Bobjectrequired
      • sidestringrequired

        Values: "A", "B"

      • labelstringrequired
      • goalsnumber | nullrequired

        Null until the score is entered

      • bibHexstring | nullrequired
      • teamIdstring | nullrequired
      • teamNamestring | nullrequired
  • participantsobject[]required
    • playerIdstringrequired
    • displayNamestringrequired
    • handlestring | nullrequired

      Null for guests

    • kindstringrequired

      Values: "registered", "guest"

    • sidestring | nullrequired

      Values: "A", "B"

    • rsvpstringrequired

      Values: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullrequired
    • attendedbooleanrequired
    • isOrganizerbooleanrequired
    • positionsstring[]required

      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

      Values: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullrequired

      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

      • smallstringrequired

        128 px

      • mediumstringrequired

        512 px

      • largestringrequired

        1024 px

  • teamsobject[]required
    • teamIdstringrequired
    • namestringrequired
    • sidestring | nullrequired

      Values: "A", "B"

    • membersnumberrequired
  • codestring | nullrequired

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

  • inviteUrlstring (uri) | nullrequired

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

  • hasVideobooleanrequired
  • kickedOffbooleanrequired
  • endedbooleanrequired

    Kick-off plus the duration has passed

  • viewerobjectrequired
    • playerIdstringrequired

      Your player id, to find yourself in participants

    • canManagebooleanrequired
    • isOrganizerbooleanrequired
    • isAdminbooleanrequired
    • rsvpstring | nullrequired

      Values: "invited", "yes", "maybe", "no"

    • sidestring | nullrequired

      Values: "A", "B"

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

  Change a match (managers)

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  Request body

  • titlestring | nulloptional

    Up to 60 characters

  • kindstringoptional

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

    Values: "pickup", "fixture"

  • datestringoptional

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

  • timestringoptional

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

  • startsAtstringoptional

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

  • durationMinnumberoptional

    Default 60

    Values: 60, 90, 120

  • venueIdstring | nulloptional
  • pitchIdstring | nulloptional

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

  • recordingstringoptional

    official only on a pitch with an official camera

    Values: "upload", "official"

  • notesstring | nulloptional

    Up to 500 characters

  • sidesobjectoptional

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

    • Aobjectoptional
      • labelstringoptional

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

      • teamIdstring | nulloptional

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

      • bibHexstring | nulloptional

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

    • Bobjectoptional
      • labelstringoptional

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

      • teamIdstring | nulloptional

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

      • bibHexstring | nulloptional

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

  data in the response

  • idstringrequired
  • titlestring | nullrequired
  • kindstringrequired

    Values: "pickup", "fixture"

  • statusstringrequired

    Values: "planned", "played", "cancelled"

  • startsAtstringrequired
  • endsAtstringrequired
  • durationMinnumberrequired
  • recordingstringrequired

    Values: "upload", "official"

  • scoreStatestringrequired

    Values: "none", "entered", "confirmed"

  • notesstring | nullrequired
  • cancelledAtstring | nullrequired
  • organizerobjectrequired
    • playerIdstringrequired
    • displayNamestringrequired
    • handlestring | nullrequired
  • venueobject | nullrequired
    • idstringrequired
    • namestringrequired
    • citystring | nullrequired
    • districtstring | nullrequired
    • addressstring | nullrequired
    • verifiedbooleanrequired
    • slugstring | nullrequired

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

    • latitudenumber | nullrequired

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

    • longitudenumber | nullrequired

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

  • pitchobject | nullrequired
    • idstringrequired
    • namestringrequired
    • indoorbooleanrequired
    • officialCamerabooleanrequired
  • cameraobject | nullrequired

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

    • idstringrequired
    • labelstringrequired
    • officialbooleanrequired
  • sidesobjectrequired
    • Aobjectrequired
      • sidestringrequired

        Values: "A", "B"

      • labelstringrequired
      • goalsnumber | nullrequired

        Null until the score is entered

      • bibHexstring | nullrequired
      • teamIdstring | nullrequired
      • teamNamestring | nullrequired
    • Bobjectrequired
      • sidestringrequired

        Values: "A", "B"

      • labelstringrequired
      • goalsnumber | nullrequired

        Null until the score is entered

      • bibHexstring | nullrequired
      • teamIdstring | nullrequired
      • teamNamestring | nullrequired
  • participantsobject[]required
    • playerIdstringrequired
    • displayNamestringrequired
    • handlestring | nullrequired

      Null for guests

    • kindstringrequired

      Values: "registered", "guest"

    • sidestring | nullrequired

      Values: "A", "B"

    • rsvpstringrequired

      Values: "invited", "yes", "maybe", "no"

    • respondedAtstring | nullrequired
    • attendedbooleanrequired
    • isOrganizerbooleanrequired
    • positionsstring[]required

      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

      Values: "goalkeeper", "defender", "midfielder", "forward"

    • photoobject | nullrequired

      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

      • smallstringrequired

        128 px

      • mediumstringrequired

        512 px

      • largestringrequired

        1024 px

  • teamsobject[]required
    • teamIdstringrequired
    • namestringrequired
    • sidestring | nullrequired

      Values: "A", "B"

    • membersnumberrequired
  • codestring | nullrequired

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

  • inviteUrlstring (uri) | nullrequired

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

  • hasVideobooleanrequired
  • kickedOffbooleanrequired
  • endedbooleanrequired

    Kick-off plus the duration has passed

  • viewerobjectrequired
    • playerIdstringrequired

      Your player id, to find yourself in participants

    • canManagebooleanrequired
    • isOrganizerbooleanrequired
    • isAdminbooleanrequired
    • rsvpstring | nullrequired

      Values: "invited", "yes", "maybe", "no"

    • sidestring | nullrequired

      Values: "A", "B"

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

  Cancel a match (managers)

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  data in the response

  • idstringrequired
  • statusstringrequired

    Values: "cancelled"

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

  Renew the match's join code (managers)

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  data in the response

  • codestringrequired

    6 letters A–Z without I and O

  • inviteUrlstring (uri)required

    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

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  Request body

  • answerstringrequired

    Values: "yes", "maybe", "no"

  data in the response

  • rsvpstringrequired

    Values: "invited", "yes", "maybe", "no"

  • sidestring | nullrequired

    Values: "A", "B"

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

  Invite one of your teams (managers)

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  Request body

  • teamIdstringrequired
  • sidestring | nulloptional

    Values: "A", "B"

  data in the response

  • invitednumberrequired
  • membersnumberrequired
• POST/api/v1/matches/{id}/participants

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

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  Request body

  • usernamestringoptional
  • sidestring | nulloptional

    Values: "A", "B"

  • guestNamestringoptional

    2–40 characters

  data in the response

  • playerIdstringrequired
  • displayNamestringrequired
  • handlestring | nullrequired

    Null for guests

  • kindstringrequired

    Values: "registered", "guest"

  • sidestring | nullrequired

    Values: "A", "B"

  • rsvpstringrequired

    Values: "invited", "yes", "maybe", "no"

  • respondedAtstring | nullrequired
  • attendedbooleanrequired
  • isOrganizerbooleanrequired
  • positionsstring[]required

    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

    Values: "goalkeeper", "defender", "midfielder", "forward"

  • photoobject | nullrequired

    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

    • smallstringrequired

      128 px

    • mediumstringrequired

      512 px

    • largestringrequired

      1024 px

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

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

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired
  • playerIdstringrequired

  Request body

  • sidestring | nulloptional

    Values: "A", "B"

  • rsvpstringoptional

    Guests only

    Values: "yes", "maybe", "no"

  data in the response

  • playerIdstringrequired
  • sidestring | nullrequired

    Values: "A", "B"

  • rsvpstringrequired

    Values: "invited", "yes", "maybe", "no"

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

  Take a player off the match (managers)

  Needs a session

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired
  • playerIdstringrequired

  data in the response

  • playerIdstringrequired
  • removedbooleanrequired

    Values: true

• GET/api/v1/venues

  Search venues

  Needs a session

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

  Show the fieldsHide the fields

  Query parameters

  • qstringoptional

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

  data in the response

  Type: object[]

  Fields of each item:

  • idstringrequired
  • namestringrequired
  • citystring | nullrequired
  • districtstring | nullrequired
  • addressstring | nullrequired
  • verifiedbooleanrequired

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

  • pitchesobject[]required
    • idstringrequired
    • namestringrequired

      e.g. "1. Saha"

    • indoorbooleanrequired
    • officialCamerabooleanrequired

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

• POST/api/v1/venues

  Add a venue

  Needs a session

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

  Show the fieldsHide the fields

  Request body

  • namestringrequired

    2–80 characters

  • citystringrequired

    2–40 characters

  • districtstring | nulloptional

    Up to 40 characters

  • addressstring | nulloptional

    Up to 160 characters

  • pitchNamestring | nulloptional

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

  • indoorbooleanoptional

    Whether that first pitch is indoors

  data in the response

  • idstringrequired
  • namestringrequired
  • citystring | nullrequired
  • districtstring | nullrequired
  • addressstring | nullrequired
  • verifiedbooleanrequired

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

  • pitchesobject[]required
    • idstringrequired
    • namestringrequired

      e.g. "1. Saha"

    • indoorbooleanrequired
    • officialCamerabooleanrequired

      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)

  Needs a session

  Show the fieldsHide the fields

  data in the response

  Type: object[]

  Fields of each item:

  • idstringrequired
  • namestringrequired
  • citystring | nullrequired
  • districtstring | nullrequired
  • addressstring | nullrequired
  • verifiedbooleanrequired

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

  • pitchesobject[]required
    • idstringrequired
    • namestringrequired

      e.g. "1. Saha"

    • indoorbooleanrequired
    • officialCamerabooleanrequired

      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

  Needs a session

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  data in the response

  • idstringrequired
  • namestringrequired
  • citystring | nullrequired
  • districtstring | nullrequired
  • addressstring | nullrequired
  • verifiedbooleanrequired

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

  • pitchesobject[]required
    • idstringrequired
    • namestringrequired

      e.g. "1. Saha"

    • indoorbooleanrequired
    • officialCamerabooleanrequired

      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

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  Request body

  • namestringrequired

    1–40 characters, unique within the venue

  • indoorbooleanoptional

  data in the response

  • idstringrequired
  • namestringrequired
  • citystring | nullrequired
  • districtstring | nullrequired
  • addressstring | nullrequired
  • verifiedbooleanrequired

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

  • pitchesobject[]required
    • idstringrequired
    • namestringrequired

      e.g. "1. Saha"

    • indoorbooleanrequired
    • officialCamerabooleanrequired

      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

  No session needed

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired
  • versionstringrequired

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

  A venue's public page

  No session needed

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

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  data in the response

  • idstringrequired
  • slugstringrequired

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

  • namestringrequired
  • verifiedbooleanrequired

    Checked by an admin; show the verified mark

  • districtstring | nullrequired
  • citystring | nullrequired
  • addressstring | nullrequired
  • descriptionstring | nullrequired

    Plain text, line breaks kept

  • logostring | nullrequired

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

  • directionsobjectrequired

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

    • googlestring (uri)required
    • applestring (uri)required
  • whatsappobject | nullrequired

    Only when the venue shows it

    • digitsstringrequired

      International, without +

    • linkstring (uri)required

      https://wa.me/<digits>

  • reservationsEnabledbooleanrequired

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

  • autoConfirmbooleanrequired

    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

  • slotMinutesnumberrequired

    Start times every 30 or 60 minutes from opening

    Values: 30, 60

  • openingHoursobjectrequired

    Istanbul clock; null: closed

    • monobject | nullrequired
      • openstringrequired

        "10:00"

      • closestringrequired

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

    • tueobject | nullrequired
      • openstringrequired

        "10:00"

      • closestringrequired

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

    • wedobject | nullrequired
      • openstringrequired

        "10:00"

      • closestringrequired

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

    • thuobject | nullrequired
      • openstringrequired

        "10:00"

      • closestringrequired

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

    • friobject | nullrequired
      • openstringrequired

        "10:00"

      • closestringrequired

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

    • satobject | nullrequired
      • openstringrequired

        "10:00"

      • closestringrequired

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

    • sunobject | nullrequired
      • openstringrequired

        "10:00"

      • closestringrequired

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

  • todaystringrequired

    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[]required
    • idstringrequired
    • namestringrequired
    • indoorbooleanrequired
• GET/api/v1/venues/{id}/availability

  Free times on a venue day, per pitch

  No session needed

  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.

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  Query parameters

  • datestringoptional

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

  • durationMinstringoptional

    60 (default), 90 or 120

  data in the response

  • datestringrequired
  • durationMinnumberrequired
  • slotMinutesnumberrequired
  • hoursobject | nullrequired

    That venue day's hours; null when closed

    • openstringrequired

      "10:00"

    • closestringrequired

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

  • leadMinutesnumberrequired

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

  • pitchesobject[]required
    • idstringrequired
    • namestringrequired
    • slotsobject[]required
      • timestringrequired

        Istanbul wall clock, "21:00"

      • datestringrequired

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

      • startsAtstringrequired

        ISO 8601 (UTC)

      • nextDaybooleanrequired

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

      • statestringrequired

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

        Values: "free", "requested", "taken", "soon", "tooFar"

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

  Ask a venue for a booking

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  Request body

  • pitchIdstringrequired
  • datestringrequired

    The venue day, YYYY-MM-DD

  • timestringrequired

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

  • durationMinnumberrequired

    Values: 60, 90, 120

  • teamIdstring | nulloptional

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

  • notestring | nulloptional

    Up to 300 characters, for the venue

  • phonestring | nulloptional

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

  • wantsMatchbooleanoptional

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

  • matchIdstring | nulloptional

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

  data in the response

  • idstringrequired
  • venueobjectrequired
    • idstringrequired
    • namestringrequired
    • verifiedbooleanrequired
    • slugstring | nullrequired

      Null once the venue's page is gone

  • pitchobjectrequired
    • idstringrequired
    • namestringrequired
  • startsAtstringrequired
  • endsAtstringrequired
  • durationMinnumberrequired
  • venueDatestringrequired

    The venue day it belongs to

  • nextDaybooleanrequired
  • statusstringrequired

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

    Values: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullrequired

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

    Values: "person", "venue"

  • teamobject | nullrequired
    • idstringrequired
    • namestringrequired
  • matchobject | nullrequired

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

    • idstringrequired
  • wantsMatchbooleanrequired
  • canCancelbooleanrequired
  • canMakeMatchbooleanrequired

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

• GET/api/v1/reservations

  Your bookings

  Needs a session

  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.

  Show the fieldsHide the fields

  data in the response

  • upcomingobject[]required
    • idstringrequired
    • venueobjectrequired
      • idstringrequired
      • namestringrequired
      • verifiedbooleanrequired
      • slugstring | nullrequired

        Null once the venue's page is gone

    • pitchobjectrequired
      • idstringrequired
      • namestringrequired
    • startsAtstringrequired
    • endsAtstringrequired
    • durationMinnumberrequired
    • venueDatestringrequired

      The venue day it belongs to

    • nextDaybooleanrequired
    • statusstringrequired

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

      Values: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullrequired

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

      Values: "person", "venue"

    • teamobject | nullrequired
      • idstringrequired
      • namestringrequired
    • matchobject | nullrequired

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

      • idstringrequired
    • wantsMatchbooleanrequired
    • canCancelbooleanrequired
    • canMakeMatchbooleanrequired

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

  • pastobject[]required
    • idstringrequired
    • venueobjectrequired
      • idstringrequired
      • namestringrequired
      • verifiedbooleanrequired
      • slugstring | nullrequired

        Null once the venue's page is gone

    • pitchobjectrequired
      • idstringrequired
      • namestringrequired
    • startsAtstringrequired
    • endsAtstringrequired
    • durationMinnumberrequired
    • venueDatestringrequired

      The venue day it belongs to

    • nextDaybooleanrequired
    • statusstringrequired

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

      Values: "pending", "confirmed", "declined", "cancelled", "lapsed"

    • answerstring | nullrequired

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

      Values: "person", "venue"

    • teamobject | nullrequired
      • idstringrequired
      • namestringrequired
    • matchobject | nullrequired

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

      • idstringrequired
    • wantsMatchbooleanrequired
    • canCancelbooleanrequired
    • canMakeMatchbooleanrequired

      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

  Needs a session

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

  Show the fieldsHide the fields

  Path parameters

  • idstringrequired

  data in the response

  • idstringrequired
  • venueobjectrequired
    • idstringrequired
    • namestringrequired
    • verifiedbooleanrequired
    • slugstring | nullrequired

      Null once the venue's page is gone

  • pitchobjectrequired
    • idstringrequired
    • namestringrequired
  • startsAtstringrequired
  • endsAtstringrequired
  • durationMinnumberrequired
  • venueDatestringrequired

    The venue day it belongs to

  • nextDaybooleanrequired
  • statusstringrequired

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

    Values: "pending", "confirmed", "declined", "cancelled", "lapsed"

  • answerstring | nullrequired

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

    Values: "person", "venue"

  • teamobject | nullrequired
    • idstringrequired
    • namestringrequired
  • matchobject | nullrequired

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

    • idstringrequired
  • wantsMatchbooleanrequired
  • canCancelbooleanrequired
  • canMakeMatchbooleanrequired

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