Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CLINTONARMANDO/apiregistropendientes/llms.txt

Use this file to discover all available pages before exploring further.

The App Version API manages version records for the mobile application. It tracks which versions have been published, whether an update is mandatory, and which platform a version targets. Two endpoints on this path are public (no authentication required), making them suitable for the mobile app to call at startup to check for required updates.
Endpoints under /app/app-version that are marked public do not require authentication and can be called by the mobile app without a Bearer token. All other endpoints require authentication.

List active versions (public)

GET /app/app-version/vigentes Returns a paginated list of active app version records. This endpoint is public — no Bearer token is required. This is useful for displaying a version history or checking which versions are currently supported.

Query parameters

page
number
default:"0"
Zero-based page index.
size
number
default:"20"
Number of records per page.

Response fields

id
number
Unique version record ID.
versionCode
string
Semantic version string (e.g., 1.2.0).
plataforma
string
Target platform (e.g., ANDROID).
obligatoria
boolean
true if users must update to this version before continuing to use the app.
descripcion
string
Release notes or change summary.
fechaPublicacion
string
Publication datetime in ISO 8601 format.
vigente
boolean
true if this version record is active.
curl --request GET \
  --url 'https://your-api.example.com/app/app-version/vigentes?page=0&size=10'

Get latest version (public)

GET /app/app-version/ultima Returns the most recently registered version record. This endpoint is public — no Bearer token is required. Use this endpoint in the mobile app’s startup routine to check whether a newer (or mandatory) version is available.
On app launch, call this endpoint and compare the returned versionCode against the currently installed version. If obligatoria is true and the installed version is older, prompt the user to update before proceeding.
curl --request GET \
  --url 'https://your-api.example.com/app/app-version/ultima'

Example response

{
  "id": 15,
  "versionCode": "2.1.0",
  "plataforma": "ANDROID",
  "obligatoria": true,
  "descripcion": "Critical security fix — update required.",
  "fechaPublicacion": "2026-05-20",
  "vigente": true
}

Create a version record

POST /app/app-version Registers a new app version. Requires authentication.

Request body

versionCode
string
required
Semantic version string (e.g., 1.2.0, 2.0.1). Follow semver conventions.
plataforma
string
required
Target mobile platform (e.g., ANDROID).
obligatoria
boolean
required
Set to true to mark this as a mandatory update. Users on older versions will be forced to update.
descripcion
string
Release notes or description of changes in this version.
fechaPublicacion
string
required
Publication datetime in ISO 8601 format (e.g. 2026-05-24T00:00:00).
vigente
boolean
Whether this version record is active. Defaults to true for new records.
Setting obligatoria: true means all mobile users on older versions will be required to update before using the app. Use this only for critical fixes or breaking changes.
curl --request POST \
  --url 'https://your-api.example.com/app/app-version' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "versionCode": "2.1.0",
    "plataforma": "ANDROID",
    "obligatoria": true,
    "descripcion": "Critical security fix and performance improvements.",
    "fechaPublicacion": "2026-05-24T00:00:00"
  }'

Typical mobile startup workflow

The following sequence shows how a mobile app should use these endpoints on startup:
1

Call GET /app/app-version/ultima

Fetch the latest version record. No token required.
2

Compare versions

Compare the returned versionCode to the installed version.
3

Check obligatoria flag

If the latest version has obligatoria: true and the installed version is older, block app access and redirect the user to the app store.
4

Proceed normally

If the installed version is current or the update is not mandatory, continue with normal app initialization (authenticate the user, fetch modules, etc.).

Build docs developers (and LLMs) love