Download OpenAPI specification:
Practice info, client management, invitations, groups and email communications
Activate a client's Kana profile and their pending therapist-client relationships after they complete the signup process. Call this endpoint from your auth or identity service immediately after a user registers — Kana will find any pending invitations for that client and mark them as active so the therapist can immediately see the client in their caseload.
Use this when:
Input:
user_id (required): The newly registered client's Kana user IDemailid (required): The client's email address (used as a fallback lookup)Returns: Count of activated therapist-client relationships.
| therapist_user_id | integer or null |
| care_team_email | string or null <email> <= 255 characters |
| client_user_id | integer or null |
| client_group_id | integer or null |
| is_profile_active | boolean or null |
| is_invitation | boolean or null |
| is_deleted | boolean or null |
{- "therapist_user_id": 0,
- "care_team_email": "user@example.com",
- "client_user_id": 0,
- "client_group_id": 0,
- "is_profile_active": true,
- "is_invitation": true,
- "is_deleted": true
}{- "therapist_user_id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phoneNumber": "string",
- "dob": "2019-08-24",
- "gender": "string",
- "care_team_email": "user@example.com",
- "client_user_id": 0,
- "client_group_id": 0,
- "id": 0,
- "is_profile_active": true,
- "is_invitation": true,
- "is_deleted": true
}Retrieve the full list of clients assigned to a specific therapist, including profile information, active session IDs, and enrollment status. Use this to display a clinician's caseload in your application or sync client lists across systems.
Use this when:
GET /{therapist_user_id}/ — Returns all active clients for the therapist, enriched with profile details and profile images.
Retrieve the full list of clients assigned to a specific therapist, including profile information, active session IDs, and enrollment status. Use this to display a clinician's caseload in your application or sync client lists across systems.
Use this when:
GET /{therapist_user_id}/ — Returns all active clients for the therapist, enriched with profile details and profile images.
| id required | integer A unique integer value identifying this therapist client. |
Validate whether a clinician can enroll a specific client (by email) into their practice on Kana, based on organization data-sharing constraints. Returns allowed: true if the client can be added, along with any pre-existing profile data for auto-fill. Returns allowed: false if the client is already assigned to the therapist or belongs to a different organization.
Use this when:
Input:
emailid (required): Client's email address to checktherapist_user_id (required): The therapist's Kana user IDReturns: {"allowed": true/false} with optional pre-existing user profile data for auto-fill when allowed is true.
| role | string or null <= 255 characters |
| firstName | string or null <= 255 characters |
| lastName | string or null <= 255 characters |
| emailid | string or null <email> <= 255 characters |
| gender | string or null <= 255 characters |
| phoneNumber | string or null <= 20 characters |
| dob | string or null <date> |
required | Array of objects (Address) |
{- "role": "string",
- "firstName": "string",
- "lastName": "string",
- "emailid": "user@example.com",
- "gender": "string",
- "phoneNumber": "string",
- "dob": "2019-08-24",
- "address": [
- {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "zipcode": "string"
}
]
}{- "role": "string",
- "firstName": "string",
- "lastName": "string",
- "emailid": "user@example.com",
- "gender": "string",
- "phoneNumber": "string",
- "dob": "2019-08-24",
- "address": [
- {
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "country": "string",
- "zipcode": "string"
}
]
}Establish a therapist-client relationship and send an onboarding invitation to the client. When a healthcare organization wants to enroll a patient into Kana under a specific clinician, this endpoint creates the relationship, configures required consent forms and clinical screenings, and sends the client an invitation email with instructions to complete signup.
Use this when:
Typical onboarding workflow:
| therapist_user_id | integer or null |
| care_team_email | string or null <email> <= 255 characters |
| client_user_id | integer or null |
| client_group_id | integer or null |
| is_profile_active | boolean or null |
| is_invitation | boolean or null |
| is_deleted | boolean or null |
{- "therapist_user_id": 0,
- "care_team_email": "user@example.com",
- "client_user_id": 0,
- "client_group_id": 0,
- "is_profile_active": true,
- "is_invitation": true,
- "is_deleted": true
}{- "therapist_user_id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phoneNumber": "string",
- "dob": "2019-08-24",
- "gender": "string",
- "care_team_email": "user@example.com",
- "client_user_id": 0,
- "client_group_id": 0,
- "id": 0,
- "is_profile_active": true,
- "is_invitation": true,
- "is_deleted": true
}Establish a therapist-client relationship and send an onboarding invitation to the client. When a healthcare organization wants to enroll a patient into Kana under a specific clinician, this endpoint creates the relationship, configures required consent forms and clinical screenings, and sends the client an invitation email with instructions to complete signup.
Use this when:
Typical onboarding workflow:
| id required | integer A unique integer value identifying this therapist client. |
| therapist_user_id | integer or null |
| care_team_email | string or null <email> <= 255 characters |
| client_user_id | integer or null |
| client_group_id | integer or null |
| is_profile_active | boolean or null |
| is_invitation | boolean or null |
| is_deleted | boolean or null |
{- "therapist_user_id": 0,
- "care_team_email": "user@example.com",
- "client_user_id": 0,
- "client_group_id": 0,
- "is_profile_active": true,
- "is_invitation": true,
- "is_deleted": true
}{- "therapist_user_id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "phoneNumber": "string",
- "dob": "2019-08-24",
- "gender": "string",
- "care_team_email": "user@example.com",
- "client_user_id": 0,
- "client_group_id": 0,
- "id": 0,
- "is_profile_active": true,
- "is_invitation": true,
- "is_deleted": true
}