User Management (1.0.0)

Create or update a user (client or therapist) in the Kana platform. This is the core user onboarding endpoint — use it to register clients into Kana when they sign up through your platform. Kana automatically handles consent setup, therapist-client linking, and org membership based on the user's role and invitation status.

Use this when:

• Onboarding a new client from your EHR or telehealth platform into Kana
• Creating a therapist account during initial setup
• Syncing user profile updates from your system into Kana

POST — Creates (or updates) the user profile. Behavior adapts based on whether the user was invited by a therapist or is self-registering.

Returns: userid (Kana's internal user ID), is_org_admin flag, and signup_time.

Create or update a user (client or therapist) in the Kana platform. This is the core user onboarding endpoint — use it to register clients into Kana when they sign up through your platform. Kana automatically handles consent setup, therapist-client linking, and org membership based on the user's role and invitation status.

Use this when:

• Onboarding a new client from your EHR or telehealth platform into Kana
• Creating a therapist account during initial setup
• Syncing user profile updates from your system into Kana

POST — Creates (or updates) the user profile. Behavior adapts based on whether the user was invited by a therapist or is self-registering.

Returns: userid (Kana's internal user ID), is_org_admin flag, and signup_time.

Retrieve a consolidated summary of a client's recent clinical activity — including when they last completed assessments, logged a mood, wrote a journal, and what goals are coming due. Use this as a single "status check" endpoint to understand a client's engagement and trigger follow-up actions.

Use this when:

• Checking a client's engagement before a therapy session
• Building a care coordinator dashboard showing which clients need follow-up
• Triggering outreach when a client hasn't completed a screening or logged mood

Response includes:

• screen_gad7_logdate / screen_phq9_logdate: Last GAD-7 / PHQ-9 screening date
• journal_logdate: Most recent journal entry timestamp
• mood_logdate: Most recent mood log timestamp
• goaltracking: Incomplete goals due within the last 10 days, grouped by date
• recommendation: Latest pending AI recommendations for the client
• chat: Start time of the most recent AI conversation session

GET /{userid}/ — Returns the activity status for the specified client.

Retrieve a consolidated summary of a client's recent clinical activity — including when they last completed assessments, logged a mood, wrote a journal, and what goals are coming due. Use this as a single "status check" endpoint to understand a client's engagement and trigger follow-up actions.

Use this when:

• Checking a client's engagement before a therapy session
• Building a care coordinator dashboard showing which clients need follow-up
• Triggering outreach when a client hasn't completed a screening or logged mood

Response includes:

• screen_gad7_logdate / screen_phq9_logdate: Last GAD-7 / PHQ-9 screening date
• journal_logdate: Most recent journal entry timestamp
• mood_logdate: Most recent mood log timestamp
• goaltracking: Incomplete goals due within the last 10 days, grouped by date
• recommendation: Latest pending AI recommendations for the client
• chat: Start time of the most recent AI conversation session

GET /{userid}/ — Returns the activity status for the specified client.

Retrieve the full profile for a client or therapist by their Kana user ID. Returns core profile information (name, email, role, demographics) along with their therapist-client relationship status if one exists.

Use this when:

• Reading back a client's profile after registering them in Kana
• Displaying user details in your clinical dashboard
• Checking a user's profile activation and invite status

GET /{userid}/ — Returns the user's profile, enriched with therapist relationship fields (is_profile_active, invite_sent).

Retrieve the full profile for a client or therapist by their Kana user ID. Returns core profile information (name, email, role, demographics) along with their therapist-client relationship status if one exists.

Use this when:

• Reading back a client's profile after registering them in Kana
• Displaying user details in your clinical dashboard
• Checking a user's profile activation and invite status

GET /{userid}/ — Returns the user's profile, enriched with therapist relationship fields (is_profile_active, invite_sent).