Listar empleados
https://api.afer.pro/api/v1/employees
POST https://api.afer.pro/consultarEmpleados
Las personas dadas de alta en tu cuenta con su departamento. Por defecto solo las activas.
El punto de partida del área: de aquí salen los empleadoId que aceptan como filtro el resto de endpoints de control horario.
La pertenencia a tu cuenta se resuelve con el mismo criterio que el módulo interno: una persona puede estar dada de alta en varias cuentas, y aquí solo se devuelven las de la tuya.
Devuelve datos de identificación y organización. No expone datos sensibles de la ficha laboral (DNI, dirección, salario ni documentación).
Envía tus claves API en las cabeceras X-API-KEY y X-API-SECRET. La cuenta sobre la que se opera se resuelve automáticamente a partir de la clave. Cómo obtener tus claves →
Este endpoint requiere autenticación con API key: sin credenciales responde 401.
Parámetros del cuerpo
El cuerpo de la petición es un objeto JSON con Content-Type: application/json.
busquedastringopcional | Texto a buscar en nombre, apellidos o email. |
departamentoIdstringopcional | Solo las personas de este departamento. Es el departamentoId de consultarDepartamentos. |
activosboolopcional | Por defecto true. Con false se incluyen también las bajas. |
Ejemplo de petición
curl -X GET 'https://api.afer.pro/api/v1/employees?departamentoId=dEp123' \
-H 'X-API-KEY: afer_tk_TU_TOKEN' \
-H 'X-API-SECRET: afer_sk_TU_SECRET'
<?php
$ch = curl_init('https://api.afer.pro/api/v1/employees?departamentoId=dEp123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-KEY: afer_tk_TU_TOKEN',
'X-API-SECRET: afer_sk_TU_SECRET',
]);
$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);
const respuesta = await fetch('https://api.afer.pro/api/v1/employees?departamentoId=dEp123', {
method: 'GET',
headers: {
'X-API-KEY': 'afer_tk_TU_TOKEN',
'X-API-SECRET': 'afer_sk_TU_SECRET'
}
});
const resultado = await respuesta.json();
Respuesta
{
"errorCode": 200,
"errorMsg": "",
"data": {
"total_empleados": 1,
"empleados": [
{
"empleadoId": "eMp001…",
"nombre": "Ana",
"apellidos": "Pons Ferrer",
"email": "ana.pons@acmeobras.com",
"activo": true,
"departamento": {
"departamentoId": "dEp123…",
"titulo": "Producción"
}
}
]
}
}
- La ficha con el contrato vigente está en obtenerEmpleado.