Obtener Empleados

Descripción

Permite obtener una lista de empleados registrados en el sistema. Es posible aplicar filtros opcionales por ID, nombre o correo electrónico, además de controlar la paginación de los resultados.

OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.

🔑 Parámetros de Consulta

Este endpoint admite filtros opcionales mediante parámetros de consulta (query parameters) para refinar los resultados.

Parámetro	Tipo	Obligatorio	Descripción
`idEmployee`	int32	No	ID único del empleado a buscar.
`name`	string	No	Nombre del empleado. Puede ser un valor parcial para búsqueda aproximada.
`email`	string	No	Correo electrónico del empleado.
`take`	int32	No	Número total de registros a retornar. Valor predeterminado: 50.
`skip`	int32	No	Número total de registros a ignorar. Valor predeterminado: 0.

📤 Estructura de la Respuesta

La respuesta devuelve una lista de empleados registrados, incluyendo información personal, profesional y de vinculación con la sucursal.

Campo	Tipo	Descripción
`idEmployee`	int32	Identificador único del empleado.
`idBranch`	int32	ID de la sucursal a la que está vinculado el empleado.
`branchName`	string	Nombre de la sucursal asociada al empleado.
`name`	string	Nombre completo del empleado.
`cpf`	string	CPF del empleado.
`accessProfile`	string	Perfil de acceso asignado al empleado en el sistema.
`status`	string	Estado actual del empleado (ej.: `Activo`, `Inactivo`, `Bloqueado`).
`currentEmail`	string	Correo electrónico actual registrado del empleado.
`login`	string	Usuario utilizado para el acceso al sistema.
`lastAccessDate`	Datetime	Fecha y hora del último acceso del empleado al sistema.
`permission`	string	Descripción de los permisos asociados al empleado.
`jobPosition`	string	Cargo o función desempeñada por el empleado.
`telephone`	string	Teléfono de contacto del empleado.
`photoUrl`	string	URL de la foto de perfil del empleado (si está disponible).

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "idEmployee": 0,
        "idBranch": 0,
        "branchName": "string",
        "name": "string",
        "cpf": "string",
        "accessProfile": "string",
        "status": "string",
        "currentEmail": "string",
        "login": "string",
        "lastAccessDate": "2019-08-24T14:15:22.123Z",
        "permission": "string",
        "jobPosition": "string",
        "telephone": "string",
        "photoUrl": "string"
    }
]

🟠400Bad Request

Get employees

Obtener Empleados#

Descripción#

🔑 Parámetros de Consulta#