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 usuarios cuyo rol corresponde a provider, aplicando filtros opcionales por ID, documento y estado.
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| filters[document] | string | No | Número de documento del proveedor |
| filters[status] | string | No | Estado del proveedor (activo / inactivo) |
| filters[user_ids] | string | No | IDs separados por comas |
| skip | integer | No | Cantidad de registros a omitir |
| take | integer | Sí | Cantidad de registros a retornar |
Pasos para ejecutar la consulta
-
Ingrese a
{BASE_URL}/api/public/v1/providers. -
Busque la sección Providers → Obtener listado paginado de proveedores.
-
En el campo take, escriba cuántos registros desea obtener.
-
Si desea aplicar filtros, agregue document, status o user_ids.
-
Pulse “Enviar petición”.
-
Si la consulta es exitosa, recibirá un 200 OK con los proveedores encontrados.
-
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.
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| filters[document] | string | No | Número de documento del usuario |
| filters[status] | string | No | Estado del usuario (activo / inactivo) |
| filters[user_ids] | string | No | IDs separados por comas |
| skip | integer | No | Cantidad de registros a omitir |
| take | integer | Sí | Cantidad de registros a retornar |
Pasos para ejecutar la consulta
-
Ingrese a
{BASE_URL}/api/public/v1/users. -
Busque la sección Users → Obtener listado paginado de usuarios.
-
En el campo take, escriba cuántos registros desea obtener.
-
Si necesita filtrar, agregue document, status o user_ids.
-
Pulse “Enviar petición”.
-
Si la información existe, recibirá un 200 OK con los datos paginados.
-
Si ocurre un error inesperado, la API responderá con 500 INTERNAL_ERROR.