Nookal MCP by usefulapi

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.

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

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.

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

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.

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

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

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

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.

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

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.

{
  "type": "object",
  "properties": {
    "date_from": {
      "description": "Appointments on or after this date, YYYY-MM-DD.",
      "type": "string"
    },
    "date_to": {
      "description": "Appointments on or before this date, YYYY-MM-DD.",
      "type": "string"
    },
    "location_ids": {
      "description": "Only these locations (numeric Nookal ids, up to 100).",
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "client_ids": {
      "description": "Only these clients (patients) (numeric Nookal ids, up to 100).",
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "provider_ids": {
      "description": "Only these practitioners (staff ids) (numeric Nookal ids, up to 100).",
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "appointment_ids": {
      "description": "Only these appointments (numeric Nookal ids, up to 100).",
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "appt_types": {
      "description": "Appointment kinds, e.g. [\"Consultation\"] or [\"Class\"].",
      "minItems": 1,
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      }
    },
    "appt_statuses": {
      "description": "Statuses as Nookal names them, e.g. [\"Completed\"], [\"Cancelled\"], [\"DNA\"] (did not arrive), [\"Pending\"].",
      "minItems": 1,
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 40
      }
    },
    "modified_from": {
      "description": "Only appointments created/updated after this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).",
      "type": "string"
    },
    "modified_to": {
      "description": "Only appointments created/updated before this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).",
      "type": "string"
    },
    "page": {
      "description": "Page number (default 1).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "page_length": {
      "description": "Items per page, 1-100 (default 50).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "first_name": {
      "description": "First name (exact, or its first letters with partial_match).",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "last_name": {
      "description": "Last name (exact, or its first letters with partial_match).",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "partial_match": {
      "description": "true = match names that start with the given letters.",
      "type": "boolean"
    },
    "date_of_birth": {
      "description": "Date of birth, YYYY-MM-DD.",
      "type": "string"
    },
    "mobile": {
      "description": "Mobile number, digits only with no spaces.",
      "type": "string",
      "pattern": "^\\+?[0-9]{4,20}$"
    },
    "email": {
      "description": "Email address.",
      "type": "string",
      "maxLength": 254,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "client_ids": {
      "description": "Only these clients (numeric Nookal ids, up to 100).",
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "location_ids": {
      "description": "Only these locations' clients (numeric Nookal ids, up to 100).",
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "online_quick_code": {
      "description": "The client's online quick code.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "active": {
      "description": "true = only active clients, false = only inactive.",
      "type": "boolean"
    },
    "deceased": {
      "description": "true = only deceased clients, false = only living clients.",
      "type": "boolean"
    },
    "modified_from": {
      "description": "Only clients created/updated after this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).",
      "type": "string"
    },
    "page": {
      "description": "Page number (default 1).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "page_length": {
      "description": "Items per page, 1-100 (default 50).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

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

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

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

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.

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

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

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