Saltar al contenido
Facturador

Listar usuarios

GET /api/users

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Lista los usuarios ordenados por id.

Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.

Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
search query no Busca por nombre o correo.
type query no seller Filtra por tipo: admin o seller.
active query no 1 Filtra por estado: 1/true activos, 0/false inhabilitados.
establishment_id query no 1 Filtra por establecimiento.
limit query no 15 Registros por página, de 1 a 100. Por defecto 15.
cursor query no Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente.

Respuestas

200 — Listado

{
  "success": true,
  "data": [
    {
      "id": 5,
      "name": "JUAN PEREZ",
      "email": "jperez@empresa.com",
      "type": "seller",
      "active": true,
      "locked": false,
      "establishment_id": 1,
      "establishment_description": "Oficina Principal",
      "document_id": "01",
      "series_id": 1,
      "identity_document_type_id": "1",
      "number": "45678912",
      "names": "JUAN",
      "last_names": "PEREZ GOMEZ",
      "personal_email": "juan.perez@gmail.com",
      "corporate_email": "jperez@empresa.com",
      "personal_cell_phone": "987654321",
      "corporate_cell_phone": "912345678",
      "position": "Vendedor",
      "photo": null
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false
  }
}

403 — Usuario no administrador

{
  "success": false,
  "message": "Solo un administrador puede gestionar este recurso."
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.