Skip to main content
GET
Lista colaboradores da unidade de negócio

Query Parameters

searchText
string

Texto pesquisado para filtrar consulta

pagina
number

Página que deseja retornar os resultados

Example:

0

limite
number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

100

situacao
enum<string>

Filtro por situação do colaborador

Available options:
ATIVO,
INATIVO,
RASCUNHO
tiposCadastro
string

Filtro por tipos de cadastro de colaborador, separados por vírgula

Example:

"PRESTADOR_SERVICO,CLT,EXTERNO,API"

dataDemissaoInicio
string<date-time>

Filtro por data de demissão inicial. Ex: "2020-01-01"

dataDemissaoFim
string<date-time>

Filtro por data de demissão final. Ex: "2030-12-31"

dataAfastamentoInicio
string<date-time>

Filtro por data de afastamento inicial. Ex: "2020-01-01"

dataAfastamentoFim
string<date-time>

Filtro por data de afastamento final. Ex: "2030-12-31"

dataFeriasInicio
string<date-time>

Filtro por data de férias inicial. Ex: "2020-01-01"

dataFeriasFim
string<date-time>

Filtro por data de férias final. Ex: "2030-12-31"

cargoIds
string

Filtro por IDs de cargo, separados por vírgula. Ex: "id1,id2"

departamentoIds
string

Filtro por IDs de departamento, separados por vírgula. Ex: "id1,id2"

equipeIds
string

Filtro por IDs de equipe, separados por vírgula. Ex: "id1,id2"

localTrabalhoIds
string

Filtro por IDs de local de trabalho, separados por vírgula. Ex: "id1,id2"

niveisAcesso
string

Filtro por níveis de acesso, separados por vírgula

Example:

"ADMIN,GESTOR,USER"

regraDePontoIds
string

Filtro por IDs de regra de ponto, separados por vírgula. Ex: "id1,id2"

batidaPontoIds
string

Filtro por IDs de batida de ponto, separados por vírgula. Ex: "id1,id2"

turnoIds
string

Filtro por IDs de turno, separados por vírgula. Ex: "id1,id2"

fusosHorarios
string

Filtro por IDs de fuso horário, separados por vírgula. Ex.: "MANAUS,NORONHA,RIO_BRANCO,SAO_PAULO"

unidadeNegocioIds
string

Filtro por IDs de unidade de negócio, separados por vírgula, Ex: "id1,id2"

centroCustoIds
string

Filtro por IDs de centro de custo, separados por vírgula, Ex: "id1,id2"

cidades
string

Filtro por cidades, separadas por vírgula. Ex: "Belo Horizonte,Goiânia"

estados
string

Filtro por estados, separados por vírgula. Ex: "MG,GO"

gestorId
string

Retorna apenas colaboradores liderados pelo gestor informado

situacaoCadastroFacial
enum<string>

Retorna apenas colaboradores com cadastro facial ativo ou inativo

Available options:
ATIVO,
INATIVO,
PENDENTE
compensatoryTimeCycleId
string

Retorna apenas colaboradores vinculados ao ciclo de banco de horas informado

compensatoryTimeMovementId
string

Retorna apenas colaboradores vinculados à movimentação de banco de horas informada

shutdownId
string

Retorna apenas colaboradores vinculados ao fechamento informado

paymentSheetExportId
string

Retorna apenas colaboradores vinculados à exportação de folha de pagamento informada

paymentSheetParameterId
string

Retorna apenas colaboradores vinculados ao ID do parâmetro de folha de pagamento informado

paymentSheetSource
enum<string>

Retorna apenas colaboradores vinculados a um de parâmetro de folha de pagamento com a fonte informada

Available options:
Keevo,
OneFlow,
Sankhya,
Tron,
Outro
paymentSheetSourceName
string

Nome da fonte do parâmetro de folha de pagamento, para o caso de uma fonte desconhecida (Outro) ou não informada

Response

Lista paginada de colaboradores com vínculo organizacional, status e dados básicos

total
number
required

Total de registros encontrados

Example:

100

colaboradores
object[]
required

Resultado da consulta

pagina
number

Pagina que deseja retornar os resultados

Example:

0

limite
number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

25