Skip to main content
Colaborador é a entidade central da Pontua — representa cada pessoa cuja jornada é registrada na plataforma. Esta é tipicamente a primeira integração que clientes fazem: sincronizar o quadro de funcionários entre o sistema de RH/folha e a Pontua.

​
Endpoints principais

​
Consultas

MétodoRotaDescrição
GET/colaboradorLista todos os colaboradores (com filtros e paginação)
GET/colaborador/{colaboradorId}Busca informações de um colaborador
GET/colaborador/{cpf}/cpfBusca colaborador pelo CPF
GET/colaborador/codigo/{codigo}Busca pelo código/matrícula
GET/colaborador/meBusca o colaborador do usuário logado
GET/colaborador/status-countContagem de colaboradores agrupada por status
GET/colaborador/birthdayLista aniversariantes do mês/dia
GET/colaborador/cidadeLista cidades com colaboradores cadastrados
GET/colaborador/export/csvExporta todos como CSV

​
Mutações

MétodoRotaDescrição
POST/colaboradorCria um novo colaborador
POST/colaborador/externoCria colaborador externo (sem conta Pontua)
POST/colaborador/importCria colaboradores em massa a partir de CSV
PATCH/colaborador/{collaboratorId}Update parcial — padrão unificado novo
PATCH/colaborador/{colaboradorId}/statusAtualiza status
PATCH/colaborador/{colaboradorId}/recuperarRecupera colaborador excluído
DELETE/colaborador/{colaboradorId}Remove um colaborador
Schema completo de request/response e try-it interativo em Referência da API.
Existem rotas legacy PATCH /colaborador/{id}/dados, PATCH /colaborador/{id}/alocacao, PATCH /colaborador/{id}/acesso, etc. — todas marcadas como deprecated. Use sempre o PATCH /colaborador/{collaboratorId} unificado com payload parcial. Ver Versionamento.

​
Casos de uso comuns

​
Sincronizar quadro do ERP

Cron noturno: lista todos os colaboradores ativos, compara com o ERP, faz upsert (create se novo, PATCH se já existe). Use paginação para datasets grandes.

​
Importar em massa via CSV

POST /colaborador/import aceita upload multipart de CSV. Útil para onboarding inicial ou migração de outro sistema.

​
Buscar antes de criar (idempotência)

CPF é único por unidade de negócio. Antes de POST /colaborador, faça GET /colaborador/{cpf}/cpf — se retornar 200, atualize com PATCH em vez de criar. Ver Idempotência.

​
Endpoints excluídos da doc pública

Por escolha de produto, não estão expostos no portal público:
  • Rotas de subperfil deprecated (/acesso, /definicoes, /preferencia, /alocacao, /complemento, /dados, /foto) — use PATCH /colaborador/{id} unificado.
  • Rotas de edição em massa (/editar-massa, /editar-massa/agendar, /alterar-nivel-acesso) — operações sensíveis, gerenciadas pelo dashboard.
  • Rotas de gestão de credenciais (/reset-password, /senha-provisoria, /mudar-senha, /pin-coletivo) — gestão de senha de usuário humano, não server-to-server.
  • Perfil-Colaborador (RG, CPF, CNH) — documentos pessoais com peso LGPD; manter restrito ao portal autenticado.

​
Veja também