# Módulo de Usuarios (Users & Providers)

Este módulo permite acceder a la información de usuarios registrados en el sistema, tanto proveedores como usuarios internos.  
Los endpoints comparten la misma estructura de autenticación, paginación y formato de respuesta que los demás módulos públicos de la API.

#### **Obtener listado paginado de proveedores**

**Función:** Obtiene un listado paginado de proveedores, aplicando filtros opcionales por ID, documento y estado.

[![image.png](https://v4.docs.airvi.com.co/uploads/images/gallery/2025-11/scaled-1680-/fTJtdGRbpomTZuqz-image.png)](https://v4.docs.airvi.com.co/uploads/images/gallery/2025-11/fTJtdGRbpomTZuqz-image.png)

**Parámetros**

<div class="_tableContainer_1rjym_1" id="bkmrk-par%C3%A1metro-tipo-oblig"><div class="group _tableWrapper_1rjym_13 flex w-fit flex-col-reverse" tabindex="-1"><table class="w-fit min-w-(--thread-content-width)" data-end="1405" data-start="978"><thead data-end="1026" data-start="978"><tr data-end="1026" data-start="978"><th data-col-size="sm" data-end="990" data-start="978">Parámetro</th><th data-col-size="sm" data-end="997" data-start="990">Tipo</th><th data-col-size="sm" data-end="1011" data-start="997">Obligatorio</th><th data-col-size="sm" data-end="1026" data-start="1011">Descripción</th></tr></thead><tbody data-end="1405" data-start="1079"><tr data-end="1150" data-start="1079"><td class="align-left" data-col-size="sm" data-end="1099" data-start="1079">filters\[document\]</td><td class="align-left" data-col-size="sm" data-end="1108" data-start="1099">string</td><td class="align-left" data-col-size="sm" data-end="1113" data-start="1108">No</td><td class="align-left" data-col-size="sm" data-end="1150" data-start="1113">Número de documento del proveedor</td></tr><tr data-end="1227" data-start="1151"><td data-col-size="sm" data-end="1169" data-start="1151">filters\[status\]</td><td data-col-size="sm" data-end="1178" data-start="1169">string</td><td data-col-size="sm" data-end="1183" data-start="1178">No</td><td data-col-size="sm" data-end="1227" data-start="1183">Estado del proveedor (activo / inactivo)</td></tr><tr data-end="1289" data-start="1228"><td data-col-size="sm" data-end="1248" data-start="1228">filters\[user\_ids\]</td><td data-col-size="sm" data-end="1257" data-start="1248">string</td><td data-col-size="sm" data-end="1262" data-start="1257">No</td><td data-col-size="sm" data-end="1289" data-start="1262">IDs separados por comas</td></tr><tr data-end="1346" data-start="1290"><td data-col-size="sm" data-end="1297" data-start="1290">skip</td><td data-col-size="sm" data-end="1307" data-start="1297">integer</td><td data-col-size="sm" data-end="1312" data-start="1307">No</td><td data-col-size="sm" data-end="1346" data-start="1312">Cantidad de registros a omitir</td></tr><tr data-end="1405" data-start="1347"><td data-col-size="sm" data-end="1354" data-start="1347">take</td><td data-col-size="sm" data-end="1364" data-start="1354">integer</td><td data-col-size="sm" data-end="1369" data-start="1364">Sí</td><td data-col-size="sm" data-end="1405" data-start="1369">Cantidad de registros a retornar</td></tr></tbody></table>

</div></div>**Pasos para ejecutar la consulta**

1. Ingrese a `{BASE_URL}/api/public/v1/providers.`
2. Busque la sección **Providers → Obtener listado paginado de proveedores**.
3. En el campo **take**, escriba cuántos registros desea obtener.
4. Si desea aplicar filtros, agregue document, status o user\_ids.
5. Pulse **“Enviar petición”**.
6. Si la consulta es exitosa, recibirá un **200 OK** con los proveedores encontrados.
7. Si ocurre un problema durante la consulta, el endpoint retornará **500 INTERNAL\_ERROR**.

#### **Consultar Listado paginado de usuarios**

**Función:** Obtiene un listado paginado de usuarios cuyo rol corresponde a **user**, excluyendo los roles **system** y **super\_administrador**, con filtros opcionales por documento, estado e IDs.

[![image.png](https://v4.docs.airvi.com.co/uploads/images/gallery/2025-11/scaled-1680-/244oAVV8yEkMGX9S-image.png)](https://v4.docs.airvi.com.co/uploads/images/gallery/2025-11/244oAVV8yEkMGX9S-image.png)

**Parámetros**

<div class="_tableContainer_1rjym_1" id="bkmrk-par%C3%A1metro-tipo-oblig-1"><div class="group _tableWrapper_1rjym_13 flex w-fit flex-col-reverse" tabindex="-1"><table class="w-fit min-w-(--thread-content-width)" data-end="2716" data-start="2293" style="width: 100%; height: 261.969px;"><thead data-end="2341" data-start="2293"><tr data-end="2341" data-start="2293" style="height: 37.7969px;"><th data-col-size="sm" data-end="2305" data-start="2293" style="width: 24.9702%; height: 37.7969px;">Parámetro</th><th data-col-size="sm" data-end="2312" data-start="2305" style="width: 24.9702%; height: 37.7969px;">Tipo</th><th data-col-size="sm" data-end="2326" data-start="2312" style="width: 24.9702%; height: 37.7969px;">Obligatorio</th><th data-col-size="sm" data-end="2341" data-start="2326" style="width: 24.9702%; height: 37.7969px;">Descripción</th></tr></thead><tbody data-end="2716" data-start="2394"><tr data-end="2463" data-start="2394" style="height: 54.5938px;"><td class="align-left" data-col-size="sm" data-end="2414" data-start="2394" style="width: 24.9702%; height: 54.5938px;">filters\[document\]</td><td class="align-left" data-col-size="sm" data-end="2423" data-start="2414" style="width: 24.9702%; height: 54.5938px;">string</td><td class="align-left" data-col-size="sm" data-end="2428" data-start="2423" style="width: 24.9702%; height: 54.5938px;">No</td><td class="align-left" data-col-size="sm" data-end="2463" data-start="2428" style="width: 24.9702%; height: 54.5938px;">Número de documento del usuario</td></tr><tr data-end="2538" data-start="2464" style="height: 46.5938px;"><td data-col-size="sm" data-end="2482" data-start="2464" style="width: 24.9702%; height: 46.5938px;">filters\[status\]</td><td data-col-size="sm" data-end="2491" data-start="2482" style="width: 24.9702%; height: 46.5938px;">string</td><td data-col-size="sm" data-end="2496" data-start="2491" style="width: 24.9702%; height: 46.5938px;">No</td><td data-col-size="sm" data-end="2538" data-start="2496" style="width: 24.9702%; height: 46.5938px;">Estado del usuario (activo / inactivo)</td></tr><tr data-end="2600" data-start="2539" style="height: 29.7969px;"><td data-col-size="sm" data-end="2559" data-start="2539" style="width: 24.9702%; height: 29.7969px;">filters\[user\_ids\]</td><td data-col-size="sm" data-end="2568" data-start="2559" style="width: 24.9702%; height: 29.7969px;">string</td><td data-col-size="sm" data-end="2573" data-start="2568" style="width: 24.9702%; height: 29.7969px;">No</td><td data-col-size="sm" data-end="2600" data-start="2573" style="width: 24.9702%; height: 29.7969px;">IDs separados por comas</td></tr><tr data-end="2657" data-start="2601" style="height: 46.5938px;"><td data-col-size="sm" data-end="2608" data-start="2601" style="width: 24.9702%; height: 46.5938px;">skip</td><td data-col-size="sm" data-end="2618" data-start="2608" style="width: 24.9702%; height: 46.5938px;">integer</td><td data-col-size="sm" data-end="2623" data-start="2618" style="width: 24.9702%; height: 46.5938px;">No</td><td data-col-size="sm" data-end="2657" data-start="2623" style="width: 24.9702%; height: 46.5938px;">Cantidad de registros a omitir</td></tr><tr data-end="2716" data-start="2658" style="height: 46.5938px;"><td data-col-size="sm" data-end="2665" data-start="2658" style="width: 24.9702%; height: 46.5938px;">take</td><td data-col-size="sm" data-end="2675" data-start="2665" style="width: 24.9702%; height: 46.5938px;">integer</td><td data-col-size="sm" data-end="2680" data-start="2675" style="width: 24.9702%; height: 46.5938px;">Sí</td><td data-col-size="sm" data-end="2716" data-start="2680" style="width: 24.9702%; height: 46.5938px;">Cantidad de registros a retornar</td></tr></tbody></table>

</div></div>**Pasos para ejecutar la consulta**

1. Ingrese a `{BASE_URL}/api/public/v1/users.`
2. Busque la sección **Users → Obtener listado paginado de usuarios**.
3. En el campo **take**, escriba cuántos registros desea obtener.
4. Si necesita filtrar, agregue document, status o user\_ids.
5. Pulse **“Enviar petición”**.
6. Si la información existe, recibirá un **200 OK** con los datos paginados.
7. Si ocurre un error inesperado, la API responderá con **500 INTERNAL\_ERROR**.