Nookal Patients API
Patient records, cases, treatment notes, and patient files.
Nookal Patients API is one of 5 APIs that Nookal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Patients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 13 operations across 13 paths, and defines 3 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Nookal Patients 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 13
Across 13 paths, the API surfaces 13 operations — 8 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Patient records, cases, treatment notes, and patient files.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Details (8 properties), AddPatientRequest (7 properties), Envelope (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nookal 4
Other APIs Nookal publishes across the network.