Skip to content
UltimateTeam.ai Docs

Version Check

GET
/api/v1/mobile/version-check
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/mobile/version-check?platform=example&current_version=example' \
  --header 'X-API-Key: <X-API-Key>'

Check whether the mobile app needs an update.

Compares the client’s current version against the configured minimum version. Returns force_update=True when the client is below the minimum, signaling that the app must update before continuing.

This endpoint is unauthenticated – the app checks version before the user logs in.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
platform
required
Platform

Mobile platform (ios or android)

string
/^(ios|android)$/

Mobile platform (ios or android)

current_version
required
Current Version

Current app version (semver)

string
/^\d+\.\d+\.\d+$/

Current app version (semver)

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
VersionCheckResponse

Response body for mobile version check.

Attributes: min_version: Minimum supported app version. latest_version: Latest available app version. force_update: Whether the app must update before use. update_url_ios: App Store URL for iOS updates. update_url_android: Play Store URL for Android updates.

object
force_update
required
Force Update
boolean
latest_version
required
Latest Version
string
min_version
required
Min Version
string
update_url_android
required
Update Url Android
string
update_url_ios
required
Update Url Ios
string
Examplegenerated
{
  "force_update": true,
  "latest_version": "example",
  "min_version": "example",
  "update_url_android": "example",
  "update_url_ios": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}