View as Markdown
Cliniko icon

Cliniko ACTION

Get Patient

Get the details of a patient by patient ID.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Cliniko account once, then configure and run Get Patient from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "cliniko-get-patient",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    cliniko: { authProvisionId: "apn_xxxxxxx" },
    patientId: "Patient ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Patient inputs
Property Type Description
patientId Patient ID string
Enter a unique patient ID.
Required Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
cliniko-get-patient
Version
0.1.2
App
Cliniko
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes