> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ugps.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Raul API

> Documentacion tecnica y referencia OpenAPI para la API de Raul

## Resumen

Esta documentacion publica expone la API de Raul a partir del esquema OpenAPI
servido por el backend productivo.

> **[Referencia API](https://docs.ugps.io/api-reference/introduction.md)**
>
> Explora endpoints, esquemas y autenticacion desde la referencia generada.

> **[Flujos comunes](https://docs.ugps.io/common-workflows.md)**
>
> Recorre autenticacion, clientes, contactos, GPS y suscripciones paso a paso.

> **[Autenticacion](https://docs.ugps.io/authentication.md)**
>
> Aprende login, Bearer JWT, refresh y manejo de errores de acceso.

> **[Permisos](https://docs.ugps.io/authorization-and-roles.md)**
>
> Revisa JWT global, RBAC admin y reglas de acceso del portal cliente.

> **[Modulos](https://docs.ugps.io/modules-overview.md)**
>
> Entiende que hace cada modulo principal antes de entrar al detalle de endpoints.

> **[Cobertura](https://docs.ugps.io/documentation-coverage.md)**
>
> Revisa que cubre hoy Mintlify y en que areas conviene ir mas a fondo.

## Endpoints clave

* **Base URL**: `https://api.raul.ugps.io`
* **Health check**: `https://api.raul.ugps.io/api/health`
* **OpenAPI JSON**: `https://api.raul.ugps.io/api/openapi.json`

> **[Health check](https://api.raul.ugps.io/api/health)**
>
> Verifica disponibilidad del backend productivo.

> **[OpenAPI JSON](https://api.raul.ugps.io/api/openapi.json)**
>
> Fuente de verdad para la referencia tecnica de esta documentacion.

> **[Introduccion API](https://docs.ugps.io/api-reference/introduction.md)**
>
> Resumen de autenticacion, consumo y enlaces operativos.

> **[Flujos comunes](https://docs.ugps.io/common-workflows.md)**
>
> Guias operativas para integraciones y recorridos frecuentes.

> **[Modulos API](https://docs.ugps.io/modules-overview.md)**
>
> Panorama funcional de Auth, Clients, GPS, Subscriptions, Billing y Analytics.

> **[Convenciones API](https://docs.ugps.io/api-conventions.md)**
>
> Paginacion, filtros, fechas, uploads, rutas legacy y recomendaciones globales.

> **[Errores y reintentos](https://docs.ugps.io/error-handling.md)**
>
> Que errores corregir, cuales reintentar y como observar fallos.

> **[Clientes](https://docs.ugps.io/clients-guide.md)**
>
> Alta, consulta, direcciones y branding basico de clientes.

> **[Contactos](https://docs.ugps.io/contacts-guide.md)**
>
> Creacion, asociacion, roles funcionales, fotos y merge.

> **[Inbox y Omnichannel](https://docs.ugps.io/omnichannel-guide.md)**
>
> Inbox unificado, shared mailboxes, sync de email, WhatsApp y tags.

> **[Ventas y cotizaciones](https://docs.ugps.io/sales-guide.md)**
>
> Quotes, pipeline, dispositivos cotizables, outreach IA y equipment sales.

> **[GPS](https://docs.ugps.io/gps-guide.md)**
>
> Equipos, catalogos, inventario y vistas operativas.

> **[Suscripciones](https://docs.ugps.io/subscriptions-guide.md)**
>
> Planes, altas, transferencias, estados y reversiones.

> **[Plataforma](https://docs.ugps.io/platform-guide.md)**
>
> Portal cliente, templates, RRHH, notificaciones y herramientas internas.

> **[Cobertura Mintlify](https://docs.ugps.io/documentation-coverage.md)**
>
> Mapa rapido de cobertura OpenAPI y guias editoriales publicadas.

> **Swagger reemplazado**
>
> `/api/docs` redirige a Mintlify y usa el esquema OpenAPI remoto.

## Notas de uso

* La referencia de endpoints se genera desde OpenAPI, no desde paginas MDX manuales.
* Si el backend agrega o cambia endpoints, la documentacion se actualiza desde
  `https://api.raul.ugps.io/api/openapi.json`.
* Si buscas un endpoint puntual, entra primero a la pestaña **API**.
* Si buscas contexto de negocio o flujos, entra primero a las paginas de **Guia**.
* `api.ugps.io` queda fuera de esta documentacion.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.