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 Notifications API delivers in-app messages to specific users. Notifications have a type (INFO, SUCCESS, WARNING, ERROR) and a read state (NO_LEIDO, LEIDO). The most common workflow is to fetch a user’s unread notifications on app load and then mark them as read when viewed.
All endpoints require a valid Bearer token. Include Authorization: Bearer <token> in every request header.

​
Create a notification

POST /api/notificaciones Creates and delivers a new notification to a specific user.

​
Request body

​
titulo
string
required
Notification title — displayed as the headline in the notification UI.
​
mensaje
string
required
Full notification message body.
​
tipo
string
required
Notification type. Controls visual styling. One of: INFO, SUCCESS, WARNING, ERROR.
​
usuarioId
number
required
ID of the user who should receive the notification.
curl --request POST \
  --url 'https://your-api.example.com/api/notificaciones' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "titulo": "Nuevo pendiente asignado",
    "mensaje": "Se te ha asignado la orden de trabajo #47 en Av. Los Pinos 250.",
    "tipo": "INFO",
    "usuarioId": 12
  }'

​
Response fields

​
id
number
Unique notification ID.
​
titulo
string
Notification title.
​
mensaje
string
Notification message body.
​
tipo
string
Type: INFO, SUCCESS, WARNING, or ERROR.
​
estado
string
Read state: NO_LEIDO (unread) or LEIDO (read).
​
fechaCreacion
string
ISO 8601 timestamp when the notification was created.
​
usuarioId
number
ID of the recipient user.

​
List all active notifications

GET /api/notificaciones Returns all notifications where vigente = true, across all users. Intended for admin use. 
curl --request GET \
  --url 'https://your-api.example.com/api/notificaciones' \
  --header 'Authorization: Bearer <token>'

​
List notifications for a user

GET /api/notificaciones/usuario/{usuarioId} Returns paginated notifications for a specific user. Use the estado query parameter to filter by read status — the most common use case is fetching unread notifications on app startup.

​
Path parameters

​
usuarioId
number
required
ID of the user whose notifications to retrieve.

​
Query parameters

​
estado
string
Filter by read status. Pass NO_LEIDO to retrieve only unread notifications. Omit to return all.
​
page
number
default:"0"
Zero-based page index.
​
size
number
default:"20"
Number of records per page.
curl --request GET \
  --url 'https://your-api.example.com/api/notificaciones/usuario/12?estado=NO_LEIDO' \
  --header 'Authorization: Bearer <token>'

​
Update a notification

PUT /api/notificaciones/{id} Updates a notification record. The primary use case is marking a notification as read by changing estado from NO_LEIDO to LEIDO.

​
Path parameters

​
id
number
required
Numeric ID of the notification to update.

​
Request body

​
estado
string
Updated read state. Pass LEIDO to mark as read.
​
titulo
string
Updated title.
​
mensaje
string
Updated message body.
To implement a “mark all as read” feature, iterate over unread notifications returned from GET /api/notificaciones/usuario/{id}?estado=NO_LEIDO and call this endpoint for each one with { "estado": "LEIDO" }.
curl --request PUT \
  --url 'https://your-api.example.com/api/notificaciones/55' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "estado": "LEIDO"
  }'

​
Delete a notification

DELETE /api/notificaciones/{id} Soft-deletes a notification by setting vigente = false. The record is retained in the database but will no longer appear in list responses.

​
Path parameters

​
id
number
required
Numeric ID of the notification to deactivate.
curl --request DELETE \
  --url 'https://your-api.example.com/api/notificaciones/55' \
  --header 'Authorization: Bearer <token>'

​
Enumerations

​
Notification types

ValueDescriptionTypical use
INFOInformational messageAssignment updates, status changes
SUCCESSSuccess confirmationWork order completed, payment recorded
WARNINGCaution or advisoryApproaching deadlines, missing data
ERRORError or failure alertSync failure, configuration error

​
Notification states

ValueDescription
NO_LEIDOUnread — notification has not been seen by the user
LEIDORead — user has viewed the notification

Build docs developers (and LLMs) love

Get started for freeTalk to us