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 Clinic API

Clinic reference data - locations, practitioners, and item/type lists.

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

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

This API exposes 7 operations across 7 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.

7 operations 7 paths 2 schemas 7 GET

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 Clinic 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 7

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

Clinic 7

Clinic reference data - locations, practitioners, and item/type lists.

GET
/getLocations
Get locations
getLocations 1 param → 200
GET
/getLocationLogo
Get location logo
getLocationLogo 1 param → 200
GET
/getPractitioners
Get practitioners
getPractitioners 2 params → 200
GET
/getPractitionerPhoto
Get practitioner photo
getPractitionerPhoto 1 param → 200
GET
/getAppointmentTypes
Get appointment types
getAppointmentTypes → 200
GET
/getClassTypes
Get class types
getClassTypes → 200
GET
/getStockList
Get stock list
getStockList → 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.

Details
object
8 properties
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nookal-clinic-api-openapi.yml Raw ↑

Other APIs Nookal publishes across the network.

Nookal Appointments API
Nookal Invoices API
Nookal Patients API
Nookal Verification API