nookal_get_availability

Get the free appointment slots per date between two dates (max 60 days, Nookal's limit), optionally for given locations, practitioners and a service. Each slot has its date, start time (24h, clinic local time), provider id and location id. Read-only: it does not book anything. Nookal GraphQL: availabilities.

read-only

Argument	Type	Description
date_to*	string	Last date, YYYY-MM-DD (at most 60 days after date_from).
date_from*	string	First date, YYYY-MM-DD.
staff_ids	array	Only these practitioners (staff ids) (numeric Nookal ids, up to 100).
service_id	integer	Only slots for this service / appointment type id (from list_services).
location_ids	array	Only these locations (numeric Nookal ids, up to 100).
slot_duration	integer	Override the slot length in minutes.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "date_from",
    "date_to"
  ],
  "properties": {
    "date_to": {
      "type": "string",
      "description": "Last date, YYYY-MM-DD (at most 60 days after date_from)."
    },
    "date_from": {
      "type": "string",
      "description": "First date, YYYY-MM-DD."
    },
    "staff_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these practitioners (staff ids) (numeric Nookal ids, up to 100)."
    },
    "service_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only slots for this service / appointment type id (from list_services).",
      "exclusiveMinimum": 0
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these locations (numeric Nookal ids, up to 100)."
    },
    "slot_duration": {
      "type": "integer",
      "maximum": 480,
      "minimum": 5,
      "description": "Override the slot length in minutes."
    }
  }
}

nookal_get_client

Get one client (patient) by id: name, date of birth, contact details, addresses, alerts, allergies, notes, occupation, referring doctor and their treatment cases; optionally a summary of their invoices (totals and balances). Health-fund, pension and online-booking codes are not returned. Nookal GraphQL: clients.

read-only

Argument	Type	Description
client_id*	integer	Nookal client id (from search_clients).
include_invoices	boolean	true = also list the client's invoices (number, date, total, paid, balance).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "client_id"
  ],
  "properties": {
    "client_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Nookal client id (from search_clients).",
      "exclusiveMinimum": 0
    },
    "include_invoices": {
      "type": "boolean",
      "description": "true = also list the client's invoices (number, date, total, paid, balance)."
    }
  }
}

nookal_list_appointments

List appointments (date, start/end time, status, type, client, practitioner, case, location, arrived / did-not-arrive flags, notes), filtered by date range, location, client, practitioner, type and status. Dates are clinic local. Nookal GraphQL: appointments.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
date_to	string	Appointments on or before this date, YYYY-MM-DD.
date_from	string	Appointments on or after this date, YYYY-MM-DD.
appt_types	array	Appointment kinds, e.g. ["Consultation"] or ["Class"].
client_ids	array	Only these clients (patients) (numeric Nookal ids, up to 100).
modified_to	string	Only appointments created/updated before this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).
page_length	integer	Items per page, 1-100 (default 50).
location_ids	array	Only these locations (numeric Nookal ids, up to 100).

nookal_list_cases

List treatment cases (id, client, title, start and referral dates, referrer, primary practitioner, notes), filtered by client, case or practitioner. Nookal GraphQL: cases.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
case_ids	array	Only these cases (numeric Nookal ids, up to 100).
client_ids	array	Only these clients' cases (numeric Nookal ids, up to 100).
page_length	integer	Items per page, 1-100 (default 50).
primary_provider_ids	array	Only these primary practitioners' cases (staff ids) (numeric Nookal ids, up to 100).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "case_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these cases (numeric Nookal ids, up to 100)."
    },
    "client_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these clients' cases (numeric Nookal ids, up to 100)."
    },
    "page_length": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 50)."
    },
    "primary_provider_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these primary practitioners' cases (staff ids) (numeric Nookal ids, up to 100)."
    }
  }
}

nookal_list_classes

List the class types offered (id, name, category, duration, price, location, online-booking settings) — the class definitions, not individual sessions. Nookal GraphQL: classes.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
class_ids	array	Only these class types (numeric Nookal ids, up to 100).
page_length	integer	Items per page, 1-100 (default 50).
location_ids	array	Only these locations' classes (numeric Nookal ids, up to 100).
online_bookings	boolean	true = only classes bookable online, false = only diary-only classes.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "class_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these class types (numeric Nookal ids, up to 100)."
    },
    "page_length": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 50)."
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these locations' classes (numeric Nookal ids, up to 100)."
    },
    "online_bookings": {
      "type": "boolean",
      "description": "true = only classes bookable online, false = only diary-only classes."
    }
  }
}

nookal_list_invoices

List invoices with their line items and payments (number, client, case, location, practitioner, date, subtotal, tax, total, paid, balance), filtered by location, invoice id or creation date. For one client's invoices use get_client with include_invoices. Nookal GraphQL: invoices.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
created_to	string	Invoices created on/before this (YYYY-MM-DD = until 23:59:59, or YYYY-MM-DD HH:MM:SS; clinic local time).
invoice_ids	array	Only these invoices (numeric Nookal ids, up to 100).
page_length	integer	Items per page, 1-100 (default 50).
voided_only	boolean	true = only voided invoices.
created_from	string	Invoices created on/after this (YYYY-MM-DD = from 00:00:00, or YYYY-MM-DD HH:MM:SS; clinic local time).
location_ids	array	Only these locations' invoices (numeric Nookal ids, up to 100).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "created_to": {
      "type": "string",
      "description": "Invoices created on/before this (YYYY-MM-DD = until 23:59:59, or YYYY-MM-DD HH:MM:SS; clinic local time)."
    },
    "invoice_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these invoices (numeric Nookal ids, up to 100)."
    },
    "page_length": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 50)."
    },
    "voided_only": {
      "type": "boolean",
      "description": "true = only voided invoices."
    },
    "created_from": {
      "type": "string",
      "description": "Invoices created on/after this (YYYY-MM-DD = from 00:00:00, or YYYY-MM-DD HH:MM:SS; clinic local time)."
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these locations' invoices (numeric Nookal ids, up to 100)."
    }
  }
}

nookal_list_locations

List the clinic's locations (id, name, address, time zone, active). Location ids are needed by most other tools. Only the locations your API client was granted are returned. Nookal GraphQL: locations.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
active	boolean	true = only active locations, false = only inactive.
page_length	integer	Items per page, 1-100 (default 50).
location_ids	array	Only these locations (numeric Nookal ids, up to 100).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "active": {
      "type": "boolean",
      "description": "true = only active locations, false = only inactive."
    },
    "page_length": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 50)."
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these locations (numeric Nookal ids, up to 100)."
    }
  }
}

nookal_list_payments

List payments received against invoices (method, amount, date, reference, invoice, client, location), filtered by invoice or payment date. Nookal GraphQL: payments.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
date_to	string	Payments on/before this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS, clinic local time).
date_from	string	Payments on/after this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS, clinic local time).
invoice_ids	array	Only these invoices' payments (numeric Nookal ids, up to 100).
page_length	integer	Items per page, 1-100 (default 50).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "date_to": {
      "type": "string",
      "description": "Payments on/before this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS, clinic local time)."
    },
    "date_from": {
      "type": "string",
      "description": "Payments on/after this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS, clinic local time)."
    },
    "invoice_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these invoices' payments (numeric Nookal ids, up to 100)."
    },
    "page_length": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 50)."
    }
  }
}

nookal_list_services

List the appointment types / services offered (id, name, category, duration in minutes, price, location, online-booking settings). Use a service id in get_availability. Nookal GraphQL: services.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
page_length	integer	Items per page, 1-100 (default 50).
service_ids	array	Only these services (numeric Nookal ids, up to 100).
location_ids	array	Only these locations' services (numeric Nookal ids, up to 100).
online_bookings	boolean	true = only services bookable online, false = only diary-only services.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "page_length": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 50)."
    },
    "service_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these services (numeric Nookal ids, up to 100)."
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these locations' services (numeric Nookal ids, up to 100)."
    },
    "online_bookings": {
      "type": "boolean",
      "description": "true = only services bookable online, false = only diary-only services."
    }
  }
}

nookal_list_staff

List staff members and practitioners (id, name, title, speciality, email, location ids, whether they are a provider / bookable online / active). Use the staff ids as provider_ids in list_appointments and staff_ids in get_availability. Nookal GraphQL: staff.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
active	boolean	true = only active staff, false = only inactive (Nookal status 1/0).
staff_ids	array	Only these staff members (numeric Nookal ids, up to 100).
page_length	integer	Items per page, 1-100 (default 50).
location_ids	array	Only these locations' staff (numeric Nookal ids, up to 100).
providers_only	boolean	true = only clinical providers (practitioners), false = only non-providers.
online_bookings	boolean	true = only staff bookable online, false = only staff not bookable online.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "active": {
      "type": "boolean",
      "description": "true = only active staff, false = only inactive (Nookal status 1/0)."
    },
    "staff_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these staff members (numeric Nookal ids, up to 100)."
    },
    "page_length": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 50)."
    },
    "location_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Only these locations' staff (numeric Nookal ids, up to 100)."
    },
    "providers_only": {
      "type": "boolean",
      "description": "true = only clinical providers (practitioners), false = only non-providers."
    },
    "online_bookings": {
      "type": "boolean",
      "description": "true = only staff bookable online, false = only staff not bookable online."
    }
  }
}

nookal_search_clients

Find clients (patients) by name, date of birth, mobile, email or id. Returns id, name, date of birth, location, active/deceased flags and contact details. With partial_match, names match on their first letters (e.g. 'Sm' finds Smith). Nookal GraphQL: clients.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
email	string	Email address.
active	boolean	true = only active clients, false = only inactive.
mobile	string	Mobile number, digits only with no spaces.
deceased	boolean	true = only deceased clients, false = only living clients.
last_name	string	Last name (exact, or its first letters with partial_match).
client_ids	array	Only these clients (numeric Nookal ids, up to 100).
first_name	string	First name (exact, or its first letters with partial_match).
page_length

Nookal MCP by usefulapi

Try it

nookal_get_availability Read-only

Nookal MCP by usefulapi

Try it

nookal_get_availability Read-only

Tools (11)