Pular para o conteúdo
CognizyCognizyAjuda
Entrar
Nesta área

Scheduling

Read booking pages and appointments.

List appointments

get/v1/public/scheduling/appointments

Paginated list of appointments. Filter by booking page, attendant, contact, status, or date range. Returns data (with attendant/service/contact) + meta.{total,page,limit,totalPages}.

Parâmetros

limitnumberopcional· consulta
Range 1–100
pagenumberopcional· consulta
tostringopcional· consulta
ISO datetime (date-only also accepted)
fromstringopcional· consulta
ISO datetime, inclusive
statusRESERVED | CONFIRMED | CANCELLED | NO_SHOW | COMPLETEDopcional· consulta
contactIdstringopcional· consulta
attendantIdstringopcional· consulta
bookingPageIdstringopcional· consulta

Respostas

  • 200

Exemplos

bash
curl -X GET "https://api.cognizy.ai/api/v1/public/scheduling/appointments" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

List booking pages

get/v1/public/scheduling/booking-pages

Returns booking pages configured in the organization. Each booking page represents a bookable service or appointment type with its slug, status, services, and attendants.

Parâmetros

Sem parâmetros.

Respostas

  • 200

Exemplos

bash
curl -X GET "https://api.cognizy.ai/api/v1/public/scheduling/booking-pages" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Get an appointment

get/v1/public/scheduling/appointments/{id}

Returns the appointment with attendant, service, contact, and bookingPage included.

Parâmetros

idstringobrigatório· caminho
Appointment ID

Respostas

  • 200Appointment returned
  • 404Appointment not found

Exemplos

bash
curl -X GET "https://api.cognizy.ai/api/v1/public/scheduling/appointments/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Toda a referência