Therapist Practice & Clients (1.0.0)

Download OpenAPI specification:

Practice info, client management, invitations, groups and email communications

Activate a Client Profile After Signup

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:

  • A patient completes signup through your platform after receiving a Kana invitation
  • Integrating Kana's enrollment flow with your own identity or auth system
  • You need to ensure therapist-client relationships are active after user registration

Input:

  • user_id (required): The newly registered client's Kana user ID
  • emailid (required): The client's email address (used as a fallback lookup)

Returns: Count of activated therapist-client relationships.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
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

Responses

Request samples

Content type
{
  • "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
}

Response samples

Content type
application/json
{
  • "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 a Therapist's Client Caseload

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:

  • Building a clinician dashboard that shows their assigned patients
  • Syncing a therapist's active caseload back into your EHR or practice management system
  • Checking which clients are enrolled under a specific therapist before scheduling sessions

GET /{therapist_user_id}/ — Returns all active clients for the therapist, enriched with profile details and profile images.

Authorizations:
cookieAuthbasicAuthNone

Responses

Retrieve a Therapist's Client Caseload

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:

  • Building a clinician dashboard that shows their assigned patients
  • Syncing a therapist's active caseload back into your EHR or practice management system
  • Checking which clients are enrolled under a specific therapist before scheduling sessions

GET /{therapist_user_id}/ — Returns all active clients for the therapist, enriched with profile details and profile images.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
integer

A unique integer value identifying this therapist client.

Responses

Check if a Client Email Can Be Added to a Therapist

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:

  • Before calling the client enrollment endpoint, to verify the email is available
  • Validating patient email input in your onboarding or scheduling interface
  • Checking if a referred patient already has a Kana profile in your organization

Input:

  • emailid (required): Client's email address to check
  • therapist_user_id (required): The therapist's Kana user ID

Returns: {"allowed": true/false} with optional pre-existing user profile data for auto-fill when allowed is true.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
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)

Responses

Request samples

Content type
{
  • "role": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailid": "user@example.com",
  • "gender": "string",
  • "phoneNumber": "string",
  • "dob": "2019-08-24",
  • "address": [
    ]
}

Response samples

Content type
application/json
{
  • "role": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailid": "user@example.com",
  • "gender": "string",
  • "phoneNumber": "string",
  • "dob": "2019-08-24",
  • "address": [
    ]
}

Enroll a Client with a Therapist

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:

  • Onboarding a new patient from your EHR or care management platform into Kana
  • Assigning an existing Kana user to a clinician in your organization
  • Configuring which consent forms and assessments a client must complete during onboarding

Typical onboarding workflow:

  1. Call this endpoint with client details, therapist ID, and consent/screening configuration
  2. Kana creates the client account (if new), links them to the therapist, and sends invite
  3. Client receives email, completes signup, and activates the relationship
  4. Therapist can now see the client in their caseload via the client list endpoint
Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
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

Responses

Request samples

Content type
{
  • "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
}

Response samples

Content type
application/json
{
  • "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
}

Enroll a Client with a Therapist

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:

  • Onboarding a new patient from your EHR or care management platform into Kana
  • Assigning an existing Kana user to a clinician in your organization
  • Configuring which consent forms and assessments a client must complete during onboarding

Typical onboarding workflow:

  1. Call this endpoint with client details, therapist ID, and consent/screening configuration
  2. Kana creates the client account (if new), links them to the therapist, and sends invite
  3. Client receives email, completes signup, and activates the relationship
  4. Therapist can now see the client in their caseload via the client list endpoint
Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
integer

A unique integer value identifying this therapist client.

Request Body schema:
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

Responses

Request samples

Content type
{
  • "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
}

Response samples

Content type
application/json
{
  • "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
}