API REST

Construa com o honors

Integre gestão de turnos e recrutamento ao seu sistema. API REST completa para Escalas e Vagas — autenticada por API key, resposta em JSON.

Começar Voltar ao início

Base URL

api.honors.com.br

Formato

JSON

Autenticação

Bearer token

Versão

v1

Autenticação

Todas as requisições (exceto a API Pública) precisam do header Authorization com sua API key no formato Bearer token.

As API keys são criadas em Configurações → Integrações dentro do produto (Escalas ou Vagas). Cada produto tem suas próprias keys e permissões.

curl https://api.honors.com.br/api/v1/users \
  -H "Authorization: Bearer rp_live_xxxxxxxxxxxx"

Atenção: Nunca exponha sua API key no frontend. Use sempre em contextos server-side ou em chamadas backend-to-backend. Keys do tipo rp_live_ afetam dados reais.

Rate limits

A API aceita até 120 requisições por minuto por API key. Ao atingir o limite, a resposta retorna status 429 Too Many Requests com o header Retry-After indicando quando tentar novamente.

Erros

Erros seguem o formato padrão com campo error ou errors.

400Bad RequestParâmetros inválidos ou ausentes.

401UnauthorizedAPI key ausente ou inválida.

402Payment RequiredRecurso não disponível no plano atual.

403ForbiddenSem permissão para executar esta ação.

404Not FoundRecurso não encontrado.

422UnprocessableValidação falhou. Confira o campo errors.

429Too Many RequestsRate limit atingido.

Escalas APIRequer API key do produto Escalas

Dashboard

GET/api/v1/dashboard

Retorna o resumo da conta: eventos abertos, usuários ativos e confirmações pendentes.

Exemplo

curl https://api.honors.com.br/api/v1/dashboard \
  -H "Authorization: Bearer rp_live_sua_key"

Usuários

GET/api/v1/users

Lista todos os membros da equipe.

Parâmetros

pageintegerPágina de resultados (padrão: 1).

per_pageintegerItens por página (máx: 100).

Exemplo

curl "https://api.honors.com.br/api/v1/users?page=1" \
  -H "Authorization: Bearer rp_live_sua_key"

GET/api/v1/users/:id

Retorna os detalhes de um membro específico.

Exemplo

curl https://api.honors.com.br/api/v1/users/uuid-do-usuario \
  -H "Authorization: Bearer rp_live_sua_key"

POST/api/v1/users/:id/absences

Registra um afastamento para o usuário.

Parâmetros

datestringobrigatórioData do afastamento (YYYY-MM-DD).

reasonstringMotivo do afastamento.

Exemplo

curl -X POST https://api.honors.com.br/api/v1/users/uuid/absences \
  -H "Authorization: Bearer rp_live_sua_key" \
  -H "Content-Type: application/json" \
  -d '{"date":"2025-08-15","reason":"Férias"}'

Equipes

GET/api/v1/teams

Lista todas as equipes da conta.

Exemplo

curl https://api.honors.com.br/api/v1/teams \
  -H "Authorization: Bearer rp_live_sua_key"

GET/api/v1/teams/:id

Retorna detalhes de uma equipe.

GET/api/v1/teams/:id/members

Lista os membros de uma equipe específica.

Eventos

GET/api/v1/events

Lista os eventos (cultos, turnos, shows) da conta.

Parâmetros

start_datestringFiltro de data inicial (YYYY-MM-DD).

end_datestringFiltro de data final (YYYY-MM-DD).

Exemplo

curl "https://api.honors.com.br/api/v1/events?start_date=2025-08-01&end_date=2025-08-31" \
  -H "Authorization: Bearer rp_live_sua_key"

GET/api/v1/events/:id

Retorna detalhes de um evento.

Escalas

GET/api/v1/schedules

Lista os itens de escala (quem está escalado em cada posição).

Parâmetros

event_iduuidFiltra por evento.

user_iduuidFiltra por usuário.

statusstringconfirmed | pending | declined

PATCH/api/v1/schedules/:id/respond

Confirma ou recusa um item de escala.

Parâmetros

statusstringobrigatórioconfirmed | declined

Exemplo

curl -X PATCH https://api.honors.com.br/api/v1/schedules/uuid/respond \
  -H "Authorization: Bearer rp_live_sua_key" \
  -H "Content-Type: application/json" \
  -d '{"status":"confirmed"}'

Mensagens

POST/api/v1/broadcasts

Envia uma mensagem broadcast para a equipe ou grupo.

Parâmetros

messagestringobrigatórioTexto da mensagem.

team_iduuidEnvia apenas para uma equipe. Se omitido, envia para todos.

channelstringwhatsapp | push | email (padrão: push)

Exemplo

curl -X POST https://api.honors.com.br/api/v1/broadcasts \
  -H "Authorization: Bearer rp_live_sua_key" \
  -H "Content-Type: application/json" \
  -d '{"message":"Ensaio amanhã às 18h — presença obrigatória."}'

Vagas APIRequer API key do produto Vagas + header X-Subdomain

Vagas

GET/hiring/jobs

Lista todas as vagas da conta.

Parâmetros

statusstringdraft | published | paused | closed

pageintegerPágina de resultados.

Exemplo

curl "https://api.honors.com.br/hiring/jobs?status=published" \
  -H "Authorization: Bearer rp_live_sua_key" \
  -H "X-Subdomain: sua-empresa"

POST/hiring/jobs

Cria uma nova vaga.

Parâmetros

titlestringobrigatórioTítulo da vaga.

descriptionstringDescrição completa.

modalitystringobrigatórioremote | on_site | hybrid

employment_typestringobrigatóriofull_time | part_time | freelance | internship

salary_minnumberSalário mínimo.

salary_maxnumberSalário máximo.

Exemplo

curl -X POST https://api.honors.com.br/hiring/jobs \
  -H "Authorization: Bearer rp_live_sua_key" \
  -H "X-Subdomain: sua-empresa" \
  -H "Content-Type: application/json" \
  -d '{"title":"Dev Sênior","modality":"remote","employment_type":"full_time"}'

GET/hiring/jobs/:id

Retorna detalhes de uma vaga incluindo pipeline e candidaturas.

PUT/hiring/jobs/:id/publish

Publica a vaga — torna visível no portal público.

PUT/hiring/jobs/:id/pause

Pausa a vaga — deixa de receber candidaturas.

PUT/hiring/jobs/:id/close

Encerra a vaga definitivamente.

Candidaturas

GET/hiring/jobs/:id/applications

Lista candidaturas de uma vaga.

Parâmetros

statusstringactive | archived | hired | rejected

stage_iduuidFiltra por etapa do pipeline.

PUT/hiring/applications/:id/move_stage

Move uma candidatura para outra etapa do pipeline.

Parâmetros

stage_iduuidobrigatórioID da etapa de destino.

Exemplo

curl -X PUT https://api.honors.com.br/hiring/applications/uuid/move_stage \
  -H "Authorization: Bearer rp_live_sua_key" \
  -H "X-Subdomain: sua-empresa" \
  -H "Content-Type: application/json" \
  -d '{"stage_id":"uuid-da-etapa"}'

PUT/hiring/applications/reorder

Reordena candidaturas dentro de uma etapa (drag & drop via API).

Parâmetros

ordered_idsarrayobrigatórioArray de IDs na nova ordem.

Pipeline

GET/hiring/jobs/:id/pipeline_stages

Lista as etapas do pipeline de uma vaga.

POST/hiring/jobs/:id/pipeline_stages

Cria uma nova etapa no pipeline.

Parâmetros

namestringobrigatórioNome da etapa (ex: Triagem, Técnico).

colorstringCor hex da etapa (ex: #6366f1).

PUT/hiring/jobs/:id/pipeline_stages/reorder

Reordena as etapas do pipeline.

Parâmetros

ordered_idsarrayobrigatórioArray de IDs na nova ordem.

Entrevistas

GET/hiring/interviews

Lista entrevistas agendadas.

Parâmetros

statusstringscheduled | completed | cancelled | no_show

POST/hiring/interviews

Agenda uma entrevista.

Parâmetros

application_iduuidobrigatórioID da candidatura.

scheduled_atdatetimeobrigatórioData e hora (ISO 8601).

modalitystringobrigatórioonline | in_person

meeting_linkstringLink para entrevista online.

duration_minutesintegerDuração em minutos (padrão: 60).

Exemplo

curl -X POST https://api.honors.com.br/hiring/interviews \
  -H "Authorization: Bearer rp_live_sua_key" \
  -H "X-Subdomain: sua-empresa" \
  -H "Content-Type: application/json" \
  -d '{"application_id":"uuid","scheduled_at":"2025-08-20T14:00:00Z","modality":"online","meeting_link":"https://meet.google.com/xxx"}'

PATCH/hiring/interviews/:id

Atualiza os dados de uma entrevista.

DELETE/hiring/interviews/:id

Cancela uma entrevista.

Propostas

GET/hiring/offers

Lista propostas de emprego enviadas.

POST/hiring/offers

Cria uma proposta para um candidato.

Parâmetros

application_iduuidobrigatórioID da candidatura.

salarynumberobrigatórioSalário proposto.

start_datestringobrigatórioData de início (YYYY-MM-DD).

messagestringMensagem personalizada para o candidato.

expires_atdatetimeValidade da proposta (ISO 8601).

POST/hiring/offers/:id/send_offer

Envia a proposta por e-mail ao candidato.

POST/hiring/offers/:id/resend_offer

Reenvia a proposta (caso o candidato não tenha respondido).

API PúblicaSem autenticação — acesso aberto

A API Pública é usada pelo portal de carreiras. Não requer autenticação, mas precisa do header X-Subdomain para identificar a empresa.

Vagas públicas

GET/hiring/public/jobs

Lista as vagas publicadas de uma empresa. Não requer autenticação.

Parâmetros

X-SubdomainheaderobrigatórioSubdomínio da empresa.

Exemplo

curl https://api.honors.com.br/hiring/public/jobs \
  -H "X-Subdomain: sua-empresa"

GET/hiring/public/jobs/:id

Detalhes de uma vaga pública.

GET/hiring/public/directory

Diretório público de empresas com vagas abertas.

Candidatura pública

POST/hiring/public/applications

Submete uma candidatura para uma vaga. Usado pelo portal de carreiras.

Parâmetros

job_iduuidobrigatórioID da vaga.

namestringobrigatórioNome completo.

emailstringobrigatórioE-mail do candidato.

phonestringTelefone.

cover_letterstringCarta de apresentação.

resume_urlstringURL do currículo (após upload via /storage/presign_resume).

consentbooleanobrigatórioConsentimento LGPD (deve ser true).

Exemplo

curl -X POST https://api.honors.com.br/hiring/public/applications \
  -H "X-Subdomain: sua-empresa" \
  -H "Content-Type: application/json" \
  -d '{"job_id":"uuid","name":"Ana Lima","email":"ana@email.com","consent":true}'

GET/hiring/public/applications/check

Verifica se um e-mail já candidatou para uma vaga.

Parâmetros

job_iduuidobrigatórioID da vaga.

emailstringobrigatórioE-mail a verificar.

Pronto para integrar?

Crie sua conta grátis e gere sua primeira API key em minutos.

Começar com Escalas Começar com Vagas