Listar usuarios
GET
/api/v1/users Devuelve una lista paginada de usuarios de tu empresa (25 por página, máximo 100). Admite filtros por estado, cargo, departamento, sede y una búsqueda por nombre o email. Por defecto cada usuario trae campos básicos (detail=reduced); con detail=full trae la ficha completa (igual que el endpoint de un usuario). La respuesta incluye un objeto meta con page, page_size y total.
Parámetros de consulta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
page | integer | No | Página a devolver (empieza en 1). |
page_size | integer | No | Resultados por página (por defecto 25, máximo 100). |
detail | string | No | Nivel de detalle: "reduced" (por defecto) o "full" (ficha completa con perfil). |
status | string | No | Filtra por estado: "active" o "disabled". |
role | string | No | Filtra por cargo: "member" o "admin". |
department_id | string | No | Filtra por departamento (id). |
work_center_id | string | No | Filtra por sede / centro de trabajo (id). |
email | string | No | Resuelve un email exacto (sin distinguir mayúsculas) a su usuario. Devuelve como mucho un resultado; úsalo para mapear tu identificador externo (el email) a nuestro id. |
q | string | No | Búsqueda por nombre completo o email (subcadena). Para un email exacto usa `email`. |
Ejemplo
Sustituye db_live_tu_clave por tu clave.
curl -s -H "Authorization: Bearer db_live_tu_clave" \
"https://api.dutybeat.com/api/v1/users?page_size=2" | jqRespuesta de ejemplo
Lo que imprime cada snippet al ejecutarlo: cURL devuelve el JSON crudo; los snippets de Python y PowerShell piden campos concretos, así que su salida es la de cada uno.
{
"data": [
{
"id": "u-dirg",
"full_name": "Alberto Vázquez Romero",
"email": "[email protected]",
"role": "admin",
"status": "active",
"has_photo": false,
"department": {
"id": "dept-dir",
"name": "Dirección General"
},
"work_center": {
"id": "wc-madrid",
"name": "Madrid – Sede central"
}
},
{
"id": "u-estm1",
"full_name": "Andrés Molina Prieto",
"email": "[email protected]",
"role": "member",
"status": "active",
"has_photo": false,
"department": {
"id": "dept-estm",
"name": "Estructuras – Madrid"
},
"work_center": {
"id": "wc-madrid",
"name": "Madrid – Sede central"
}
}
],
"meta": {
"page": 1,
"page_size": 2,
"total": 17
}
}