Obter agendamento por ID

Um agendamento da clínica da chave. Id de outra clínica responde 404, como se não existisse. Escopo: scheduling:read.

GET /v1/scheduling/appointments/{id}

Obter agendamento por ID

cURL

curl --request GET \
  --url https://api.controleclinic.com.br/v1/scheduling/appointments/{id} \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clinic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "professional_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "procedure_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_at": "<string>",
  "end_at": "<string>",
  "status": "scheduled",
  "notes": "<string>",
  "room_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "technology_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "origem": "importacao",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Autorizações

X-API-Key · string · header · obrigatório

Token de API no formato cc_live_<64 chars hex>. Obtido em Minha Clínica → Integrações.

Parâmetros de caminho

id · string<uuid> · obrigatório

Resposta

200

application/json

Agendamento encontrado

id · string<uuid> · obrigatório

clinic_id · string<uuid> · obrigatório

patient_id · string<uuid> · obrigatório

professional_id · string<uuid> | null · obrigatório

procedure_id · string<uuid> | null · obrigatório

start_at · string · obrigatório

end_at · string · obrigatório

status · enum<string> · obrigatório

Opções disponíveis: scheduled, confirmed, completed, cancelled, no_show

notes · string | null · obrigatório

room_id · string<uuid> | null · obrigatório

technology_id · string<uuid> | null · obrigatório

session_id · string<uuid> | null · obrigatório

origem · enum<string> | null · obrigatório

Opções disponíveis: importacao

created_at · string · obrigatório

updated_at · string · obrigatório