{"openapi":"3.1.0","info":{"title":"Healthie (BYOK) API","version":"0.1.0","description":"Healthie (BYOK) lets an AI assistant read your own Healthie data through the Healthie API with a key you supply (Healthie API key). Read-only: 7 tools (list_appointment_types, get_appointment_type, list_appointments, get_appointment, list_availabilities, list_programs, get_program). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-healthie.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-healthie/docs"},"termsOfService":"https://connectorbay.com/byok-healthie/terms"},"servers":[{"url":"https://byok-healthie.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-healthie/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_appointment_types":{"post":{"operationId":"list_appointment_types","summary":"List the appointment types of the Healthie account with name, length in minutes, available contact types and group and w","description":"List the appointment types of the Healthie account with name, length in minutes, available contact types and group and waitlist flags. Offset-paged. Use for \"What appointment types does my Healthie account offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"keywords":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Optional text to search appointment type names by.","title":"Keywords"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip (offset pagination, default 0).","title":"Offset"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many appointment types to return per page (1 to 100; Healthie's own default when left out).","title":"Page Size"}},"title":"list_appointment_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_appointment_type":{"post":{"operationId":"get_appointment_type","summary":"Get one appointment type by ID: name, length in minutes and available contact types. Use for \"Show Healthie appointment ","description":"Get one appointment type by ID: name, length in minutes and available contact types. Use for \"Show Healthie appointment type 1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"ID of the appointment type, as returned by list_appointment_types.","maxLength":40,"title":"Id","type":"string"}},"required":["id"],"title":"get_appointment_typeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_appointments":{"post":{"operationId":"list_appointments","summary":"List the organization's appointments with date, length, contact type, location, provider and appointment type. Patient n","description":"List the organization's appointments with date, length, contact type, location, provider and appointment type. Patient names and contact details are not requested. Offset-paged by Healthie's default page size. Use for \"What appointments are on the books in my Healthie account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip (offset pagination, default 0).","title":"Offset"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active appointments, false for inactive ones; leave out for Healthie's default.","title":"Is Active"},"with_all_statuses":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include appointments in every status (cancelled, no-show and others).","title":"With All Statuses"}},"title":"list_appointmentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_appointment":{"post":{"operationId":"get_appointment","summary":"Get one appointment by ID: date, contact type, status, provider and appointment type. The patient is not requested. Use ","description":"Get one appointment by ID: date, contact type, status, provider and appointment type. The patient is not requested. Use for \"Show Healthie appointment 55\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"ID of the appointment, as returned by list_appointments.","maxLength":40,"title":"Id","type":"string"}},"required":["id"],"title":"get_appointmentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_availabilities":{"post":{"operationId":"list_availabilities","summary":"List provider availability slots (weekday, duration text, repeating flag, range and time zone). Healthie returns nothing","description":"List provider availability slots (weekday, duration text, repeating flag, range and time zone). Healthie returns nothing unless one of one_time or is_repeating is true. Use for \"Which repeating availability slots are set up in my Healthie account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"is_repeating":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to list repeating availabilities.","title":"Is Repeating"},"one_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list one-time availabilities.","title":"One Time"}},"title":"list_availabilitiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_programs":{"post":{"operationId":"list_programs","summary":"List Healthie programs (courses) with name, description, type (rolling or fixed) and start date. Offset-paged. Use for \"","description":"List Healthie programs (courses) with name, description, type (rolling or fixed) and start date. Offset-paged. Use for \"What programs does my Healthie account offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"keywords":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Optional text to search program names and descriptions by.","title":"Keywords"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many records to skip (offset pagination, default 0).","title":"Offset"},"course_type":{"anyOf":[{"enum":["rolling","fixed"],"type":"string"},{"type":"null"}],"default":null,"description":"Only programs of this type.","title":"Course Type"},"only_available":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True for programs that are rolling or start in the future.","title":"Only Available"}},"title":"list_programsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_program":{"post":{"operationId":"get_program","summary":"Get one Healthie program by ID with name, description, type, start date and its modules (category, item type, item ID). ","description":"Get one Healthie program by ID with name, description, type, start date and its modules (category, item type, item ID). Use for \"Show Healthie program 3\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"course_id":{"description":"ID of the program, as returned by list_programs.","maxLength":40,"title":"Course Id","type":"string"}},"required":["course_id"],"title":"get_programArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}