Consultar aniversariantes

Permite listar os pacientes que fazem aniversário dentro de um determinado intervalo de dias e meses, facilitando ações de relacionamento, envio de felicitações e campanhas da clínica.

Como funciona a busca

A rota compara exclusivamente o dia e o mês de nascimento do paciente cadastrado, ignorando o ano de nascimento.

curl -G "https://api.clinicanasnuvens.com.br/paciente/aniversariantes" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  --data-urlencode "dataInicial=2026-10-01" \
  --data-urlencode "dataFinal=2026-10-15" \
  --data-urlencode "pagina=0" \
  --data-urlencode "registrosPorPagina=50"

Parâmetros de consulta

Parâmetro	Obrigatório	Padrão	Descrição
dataInicial	Sim	—	Início do período (formato YYYY-MM-DD). Apenas o dia e o mês são comparados
dataFinal	Não	Igual a dataInicial	Fim do período (formato YYYY-MM-DD). Se omitido, consulta apenas o dia exato da dataInicial
pagina	Não	0	Número da página desejada (começando em 0)
registrosPorPagina	Não	50	Quantidade de registros por página (máximo 100)

Regras e comportamentos

• Limite de 31 dias: O intervalo entre dataInicial e dataFinal não pode ultrapassar 31 dias. Intervalos superiores ou com dataFinal anterior a dataInicial retornam 400 Bad Request.
• Dia único sem dataFinal: Enviar apenas dataInicial faz a busca assumir o mesmo valor para dataFinal, retornando os aniversariantes de um único dia específico.
• Suporte a virada de ano civil: O filtro aceita períodos que cruzam o fim do ano (por exemplo, de 2026-12-28 a 2027-01-03). A comparação identifica aniversariantes dos últimos dias de dezembro e dos primeiros dias de janeiro.
• Somente pacientes ativos: A consulta retorna apenas pacientes com cadastro ativo na clínica do token informado.
• Cálculo da idade no período: O campo idade reflete a idade que o paciente está completando no aniversário daquele período consultado (a diferença entre o ano da ocorrência do aniversário no período e o ano de nascimento do paciente).

Resposta paginada

A resposta vem encapsulada na estrutura padrão de paginação (PageAPI):

{
  "pagina": 0,
  "totalPaginas": 1,
  "lista": [
    {
      "id": 12345,
      "nome": "Jackson Without Micheal",
      "nomeSocial": null,
      "dataNascimento": "2009-01-01",
      "idade": 17,
      "contato": {
        "email": "jackson@exemplo.com.br",
        "telefoneCelular": "349563463634",
        "telefoneComercial": null,
        "telefoneResidencial": null,
        "telefoneRecados": null
      }
    }
  ]
}

Campos do retorno

Campo	Descrição
id	Identificador do paciente nesta clínica (paciente.id)
nome	Nome civil completo do paciente
nomeSocial	Nome social cadastrado (ou null se não informado)
dataNascimento	Data de nascimento no formato YYYY-MM-DD
idade	Idade completada pelo paciente no aniversário do período consultado
contato	Dados de contato vinculados: email, telefoneCelular, telefoneComercial, telefoneResidencial e telefoneRecados

Veja na Referência

Os detalhes de cada operação, campo a campo, estão em Referência › Paciente › Listar aniversariantes.