Listar recursos de disponibilidade

Esta operação lista de forma paginada todos os recursos cadastrados e habilitados na disponibilidade da clínica, abrangendo profissionais de saúde, salas e equipamentos.

É o ponto de partida ideal para parceiros e integrações que precisam descobrir quais recursos existem na clínica e quais estão ativos para consulta de disponibilidade e agendamento.

Requisito: Nova Disponibilidade

Esta operação é exclusiva para clínicas que possuem o recurso da Nova Disponibilidade habilitado no Clínica nas Nuvens. Se a funcionalidade não estiver ativa na clínica do token autenticado, a chamada retornará erro HTTP 400 Bad Request com a mensagem: "A busca de disponibilidade unificada é uma funcionalidade exclusiva da nova disponibilidade."

curl -G "https://api.clinicanasnuvens.com.br/disponibilidade/recursos" \
  -H "Authorization: Basic BASE64_DO_CLIENT_ID_E_SECRET" \
  -H "clinicaNasNuvens-cid: SEU_TOKEN_DE_CLINICA" \
  --data-urlencode "pagina=0" \
  --data-urlencode "registrosPorPagina=50" \
  --data-urlencode "tipoRecurso=PROFISSIONAL" \
  --data-urlencode "ativo=true"

Parâmetros de consulta (Query Params)

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
tipoRecurso	Enum	Não	Todos os tipos	Tipo do recurso a listar: PROFISSIONAL, SALA ou EQUIPAMENTO.
nome	String	Não	—	Busca textual parcial pelo nome do recurso ou profissional.
ativo	Boolean	Não	true	Filtra por situação ativa na disponibilidade (true para ativos, false para inativos).
pagina	Integer	Não	0	Índice da página desejada, começando em 0 (base zero). Valores negativos são tratados como 0.
registrosPorPagina	Integer	Não	50	Quantidade de registros por página. O padrão é 50 e o limite máximo é 100 (valores acima de 100 são ajustados silenciosamente para 100).

Exemplo de resposta

A resposta utiliza o envelope paginado padrão da API (exemplo listando com tipoRecurso=PROFISSIONAL):

{
  "pagina": 0,
  "totalPaginas": 1,
  "lista": [
    {
      "idRecurso": 42,
      "idExecutorAgenda": 10,
      "idPessoaExecutor": 105,
      "tipoRecurso": "PROFISSIONAL",
      "nome": "Dra. Maria Silva",
      "ativo": true
    }
  ]
}

Identificadores por Tipo de Recurso

• Para recursos do tipo PROFISSIONAL, os campos idExecutorAgenda e idPessoaExecutor são preenchidos com os respectivos identificadores de executor e pessoa associados ao profissional na clínica.
• Para recursos do tipo SALA ou EQUIPAMENTO, os campos idExecutorAgenda e idPessoaExecutor retornam como null, devendo ser utilizado o campo idRecurso.

Utilização no fluxo de agendamento

Os identificadores retornados nesta listagem são usados para:

• Consultar disponibilidade: Utilize idRecurso (ou idExecutorAgenda para profissionais) no parâmetro codigoRecurso das rotas de disponibilidade (GET /disponibilidade e GET /disponibilidade/proximo-horario).
• Gravar agendamento (POST /agenda/novo):
  • Para profissionais, envie idPessoaExecutor.
  • Para salas ou equipamentos, envie o objeto na lista de recursos adicionais:

    "recursos": [
      {
        "idRecurso": 88,
        "tipoRecurso": "SALA"
      }
    ]

Consulte o guia Criar um agendamento para detalhes do payload completo.

Operações relacionadas

• Consultar disponibilidade de horários: Para consultar a grade de horários livres de um período.
• Consultar próximo horário disponível: Para localizar a primeira vaga disponível de um recurso.

Veja na Referência

Os detalhes de cada campo estão em Referência › Disponibilidade › Listar recursos de disponibilidade.