Obter Funcionários

Descrição

Permite obter uma lista de funcionários(employees) cadastrados no sistema. É possível aplicar filtros opcionais por ID, nome ou e-mail, além de controlar a paginação dos resultados.

🔑 Parâmetros de Consulta

Este endpoint suporta filtros opcionais através de parâmetros de consulta (query parameters) para refinar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
idEmployee	int32	Não	ID único do colaborador a ser buscado.
name	string	Não	Nome do colaborador. Pode ser um valor parcial para busca aproximada.
email	string	Não	E-mail do colaborador.
take	int32	Não	Número total de registros a serem retornados. Valor padrão é 50.
skip	int32	Não	Número total de registros a serem ignorados. Valor padrão é 0.

📤 Estrutura de Resposta

A resposta retorna uma lista de colaboradores cadastrados, contendo informações pessoais, profissionais e de vínculo com a unidade.

Campo	Tipo	Descrição
idEmployee	int32	Identificador único do colaborador.
idBranch	int32	ID da filial à qual o colaborador está vinculado.
branchName	string	Nome da filial associada ao colaborador.
name	string	Nome completo do colaborador.
email	string	Endereço de e-mail do colaborador.
telephone	string	Telefone de contato do colaborador.
jobPosition	string	Cargo ou função exercida pelo colaborador.
status	boolean	Indica se o colaborador está ativo (`true`) ou inativo (`false`).
photoUrl	string	URL da foto de perfil do colaborador (se disponível).

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",
        "email": "string",
        "telephone": "string",
        "jobPosition": "string",
        "status": true,
        "photoUrl": "string"
    }
]

🟠400Bad Request

Get employees

Obter Funcionários#

Descrição#

🔑 Parâmetros de Consulta#