Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nookal Appointments API

Appointments, class bookings, availabilities, and the waiting list.

Nookal Appointments API is one of 5 APIs that Nookal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Appointments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 10 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version v2.

Requests are made against a single base URL, https://api.nookal.com/production/v2.

10 operations 10 paths 2 schemas 5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v2
Base URL
https://api.nookal.com/production/v2
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Nookal Appointments API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (apiKeyQuery). By default, every request must be authenticated.

  • apiKeyQuery — Account-issued API key created in the Nookal application under Setup / Integrations, with a configurable access level. Passed as the apikey parameter - in the…

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Appointments 10

Appointments, class bookings, availabilities, and the waiting list.

GET
/getAppointments
Get appointments
getAppointments 9 params → 200
GET
/getAppointmentAvailabilities
Get appointment availabilities
getAppointmentAvailabilities 4 params → 200
GET
/getClassAvailabilities
Get class availabilities
getClassAvailabilities 5 params → 200
POST
/addAppointmentBooking
Add an appointment booking
addAppointmentBooking body → 200
POST
/updateAppointmentBooking
Update an appointment booking
updateAppointmentBooking body → 200
POST
/addClassBooking
Add a class booking
addClassBooking body → 200
POST
/cancelAppointment
Cancel an appointment
cancelAppointment body → 200
POST
/rebookAppointment
Rebook an appointment
rebookAppointment body → 200
GET
/getClassParticipants
Get class participants
getClassParticipants 1 param → 200
GET
/getWaitingList
Get waiting list
getWaitingList 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Details (8 properties), Envelope (3 properties). Each schema is shown below with its type and property counts.

Envelope
object
Standard Nookal JSON response envelope. On success, status is "success" and data carries the results object; on failure, status is "failure" and details carrie…
3 properties
Details
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nookal-appointments-api-openapi.yml Raw ↑

Other APIs Nookal publishes across the network.

Nookal Clinic API
Nookal Invoices API
Nookal Patients API
Nookal Verification API