Lista colaboradores da unidade de negócio

curl --request GET \
  --url https://api.example.com/colaborador

{
  "total": 100,
  "colaboradores": [
    {
      "colaboradorId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
      "nivelAcesso": "USER",
      "nome": "Douglas Coelho",
      "tipoColaborador": "CLT",
      "tipoIdentificacao": "CPF",
      "numeroDocumento": "71055398712",
      "unidadeNegocio": {
        "unidadeNegocioId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Tron",
        "foto": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
        "tax": "71055398712"
      },
      "cargo": {
        "cargoId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Analista de Marketing"
      },
      "departamento": {
        "departamentoId": "c9f447fe-f97f-4f24-974d-9f92eb3049dc",
        "nome": "Desenvolvimento"
      },
      "situacao": "ATIVO",
      "numeroPrevidenciario": "N586692225",
      "equipe": {
        "equipeId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Squad Plataforma"
      },
      "email": "douglas@empresa.com.br",
      "celular": "+5562999999999",
      "dataAdmissao": "2024-01-15T00:00:00.000Z",
      "dataDemissao": "2026-05-07T00:00:00.000Z",
      "createdAt": "2024-01-10T12:34:56.000Z",
      "updatedAt": "2024-02-20T08:22:11.000Z",
      "localTrabalho": {
        "localTrabalhoId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Sede Goiânia"
      },
      "centroCusto": {
        "centroCustoId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Tecnologia / R&D"
      },
      "dataInicio": "2024-01-15T00:00:00.000Z",
      "statusFacial": "COMPLETO",
      "foto": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
      "facialId": {
        "id": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "codigoFacial": "FULANO.10",
        "situacao": "Ativo",
        "dataExpiracao": "2025-07-23T00:00:00.000Z"
      }
    }
  ],
  "pagina": 0,
  "limite": 25
}

Colaborador

Lista colaboradores da unidade de negócio

Retorna todos os colaboradores da unidade de negócio do token autenticado, com filtros e paginação. Endpoint mais consumido em integrações de RH e ERP.

Casos de uso típicos:

Sincronizar quadro de funcionários com folha de pagamento externa (Domínio, Sage, ERP próprio)
Popular dropdown “selecionar colaborador” em sistemas internos
Auditoria de quadro ativo vs. inativo
Detectar admissões/demissões desde a última sync (use updatedAt no filtro)

Filtros úteis:

status — filtra por estado: ATIVO, INATIVO, AFASTADO, DEMITIDO
departamentoId, cargoId, equipeId, unidadeId — corte organizacional
searchText — busca por nome, código ou CPF
pagina + limite — paginação Pontua padrão (ver Paginação)

Soft-delete: colaboradores excluídos (status DEMITIDO) continuam aparecendo nas consultas — é a fonte de verdade histórica para folha. Para listar apenas ativos, filtre explicitamente status=ATIVO.

Multi-tenant: o token determina a UN. Para listar colaboradores de outras UNs, use uma chave criada na UN-alvo (uma chave por UN).

Veja o guia Sincronizar frequência com ERP para padrão cron noturno.

GET

colaborador

Lista colaboradores da unidade de negócio

curl --request GET \
  --url https://api.example.com/colaborador

{
  "total": 100,
  "colaboradores": [
    {
      "colaboradorId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
      "nivelAcesso": "USER",
      "nome": "Douglas Coelho",
      "tipoColaborador": "CLT",
      "tipoIdentificacao": "CPF",
      "numeroDocumento": "71055398712",
      "unidadeNegocio": {
        "unidadeNegocioId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Tron",
        "foto": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
        "tax": "71055398712"
      },
      "cargo": {
        "cargoId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Analista de Marketing"
      },
      "departamento": {
        "departamentoId": "c9f447fe-f97f-4f24-974d-9f92eb3049dc",
        "nome": "Desenvolvimento"
      },
      "situacao": "ATIVO",
      "numeroPrevidenciario": "N586692225",
      "equipe": {
        "equipeId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Squad Plataforma"
      },
      "email": "douglas@empresa.com.br",
      "celular": "+5562999999999",
      "dataAdmissao": "2024-01-15T00:00:00.000Z",
      "dataDemissao": "2026-05-07T00:00:00.000Z",
      "createdAt": "2024-01-10T12:34:56.000Z",
      "updatedAt": "2024-02-20T08:22:11.000Z",
      "localTrabalho": {
        "localTrabalhoId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Sede Goiânia"
      },
      "centroCusto": {
        "centroCustoId": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "nome": "Tecnologia / R&D"
      },
      "dataInicio": "2024-01-15T00:00:00.000Z",
      "statusFacial": "COMPLETO",
      "foto": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
      "facialId": {
        "id": "b5887a64-6aa1-43e8-b233-ffadc7f92ca6",
        "codigoFacial": "FULANO.10",
        "situacao": "Ativo",
        "dataExpiracao": "2025-07-23T00:00:00.000Z"
      }
    }
  ],
  "pagina": 0,
  "limite": 25
}

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

Show child attributes

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

Atualiza valores do Centro de Custo Conta colaboradores agrupados por status