Kareforce.API

Retrieves the list of Agencies Lead with optional filtering, sorting, and pagination.

Retrieves Agency Lead details by its Id.

{requestId*}

Updates the status of an Agency Lead.

{id*, leadStatus*}

Creates a new Agency Lead.

{AgencyName*, PersonName*, Email*, Phone*, AlternatePhone, Address*, City*, StateId*, CountryId*, PostalCode*}

Deletes an Agency Lead by Id.

{id*}

Export agency lead data to Excel or CSV format.

CommonExportRequestModel with optional filters. File content as byte array.

Retrieves the live counts of Admin Dashboard with Support Tickets Section.

Retrieves the list of Admin Agency with optional filtering, sorting, and pagination.

Retrieves Admin agency details by its Id.

{requestId*}

Adds a new agency entry.

{AgencyName* ,PersonName* ,Email* ,Phone* ,AlternatePhone ,Address* ,City* ,StateId* ,CountryId* ,PostalCode* }

Updates an existing agency entry.

{Id* ,AgencyName* ,PersonName* ,Email* ,Phone* ,AlternatePhone ,Address* ,City* ,StateId* ,CountryId* ,PostalCode* }

Delete agency entry by its Id.

{requestId*}

update admin agency status

{Id* ,Staus* } Status:{ Inactive= 0 ,Active= 1, Delete=2}

get associated caregiver list with agency

{requestId* }

get associated Client list with agency

{requestId* }

Export agency data to Excel or CSV format.

CommonExportRequestModel with optional filters. File content as byte array.

Retrieves the list of Admin caregiver list with optional filtering, sorting, and pagination.

Retrieves Admin caregiver details by its Id.

{requestId*}

update admin caregiver status

{Id* ,Staus* } Status:{ Inactive= 0 ,Active= 1, Delete=2}

Export caregiver data to Excel or CSV format.

CommonExportRequestModel with optional filters. File content as byte array.

Retrieves the list of Clients with optional filtering, sorting, and pagination.

Update Client status

{Id* ,Status*} Status:{ Inactive= 0 ,Active= 1}

Gets Client details by Id.

{RequestId*}

Export client data to Excel or CSV format.

CommonExportRequestModel with optional filters. File content as byte array.

Retrieves the list of Admin User Role with optional filtering, sorting, and pagination.

Retrieves the list of Admin Menu.

Retrieves Admin Role details by its Id.

{requestId*}

Adds a new Admin Role with menu permission entry.

{RoleName* ,Description } DashboardType = {Admin = 1 ,Executive = 2}

Updates an existing Admin Role entry.

DashboardType = {Admin = 1 ,Executive = 2}

Delete Admin Role entry by its Id.

{requestId*}

Get all support tickets for admin with search and filter options. Returns Username, Title, Description, AddedBy, AdminComments, FileNames, Status, SubmittedByType

Update admin comments and status for a support ticket.

Delete a support ticket. Only allowed when status is Resolved or Rejected.

Get a support ticket by Id for admin. Returns Title, Description, AdminComments, FileNameList.

Authenticate and signs in the specified Adminuser.

The object.

This API will be used to resend activation code or sending Password Reset Code for forgot password

{email* ,verificationCodeType* } VerificationCodeType = {Activation = 1,ResetPassword = 2} resend code sent

This API will be used to ResetPassword password

{email* ,verificationCode* ,password*} Reset Password response

Sets the password for an invited Admin user.

This endpoint is used to set or reset the password for an Admin user who has been invited to join the Admin. The request must contain the invitation token and the new password details. {token* ,password*} A JSON response indicating the result of the operation. Returns: A 200 OK response with an if the password is set successfully. A 400 Bad Request response if the input model is invalid or an error occurs.

Resends the invitation link to an Admin user.

{RequestId : selected user id}

Retrieves the list of Admin User with optional filtering, sorting, and pagination.

Retrieves Admin user details by its Id.

{requestId*}

Adds a new Admin user entry.

{FirstName* ,LastName* ,Email* ,Phone* ,RoleId* }

Updates an existing Admin User entry.

{Id* ,FirstName* ,LastName* ,Email* ,Phone* ,RoleId* }

Delete Admin User entry by its Id.

{requestId*}

update admin user status

{Id* ,Staus* } Status:{ Inactive= 0 ,Active= 1, Delete=2}

Retrieves Admin Profile details by its Id.

Change user password.

Retrieves the live counts of Agency Dashboard with Today’s Introduction Meetings Section.

Retrieves the list of Agency Client with optional filtering, sorting, and pagination.

update Agency Client status

{Id* ,Staus* } Status:{ Inactive= 0 ,Active= 1}

delete Agency Client

{Id* }

Adds a new Agency Client.

{FirstName* ,LastName* ,Email* ,Phone* ,AlternatePhone ,Gender* ,Age* ,Address* ,City* ,StateId* ,PostalCode* ,Country*, GoalList, PreferredLanguage} ResponseViewModel Gender : Male=1, Female=2

Gets Agency Client details by Id.

Guid ResponseViewModel

Get client details by unique identifier (UniqueId). UniqueId*

Associate an existing Client with the current agency. Guid*

Send invitation code to a client by email. Email*

Update client user profile details by user id.

EquipmentId pass value like {"agesWorked": [1, 2, 3]}

Export agency client data to Excel or CSV format.

CommonExportRequestModel with optional filters. File content as byte array.

Import client data from Excel or CSV format.

CommonImportRequestModel with filename and bytearray. File content as byte array.

Retrieves the list of Agency User Role with optional filtering, sorting, and pagination.

Retrieves the list of Agency Menu.

Retrieves Agency Role details by its Id.

{requestId*}

Adds a new Agency Role with menu permission entry.

{ RoleName * ,Description }

Updates an existing Agency User entry.

{RoleId*,RoleName, Description }

Delete Agency Role entry by its Id.

{requestId*}

Get all support tickets for current agency (paged). Returns Title, Description, File (path/url), AdminComments, Status

Create new support ticket for the agency. Title, Description are required. FileName is a list of relative filenames/paths (front-end / upload flow should provide these).

Edit existing support ticket. Title and Description are required.

Permanently delete a support ticket. Only allowed when ticket status = Pending.

Get a support ticket by Id for agency. Returns Title, Description, FileNameList, FileUrls, AdminComments, etc.

Authenticate and signs in the specified Agency user.

The object.

This API will be used to resend activation code or sending Password Reset Code for forgot password

{email* ,verificationCodeType* } VerificationCodeType = {Activation = 1,ResetPassword = 2} resend code sent

This API will be used to forgot password

{email* ,verificationCode* ,password*} Reset Password response

Sets the password for an invited agency user.

This endpoint is used to set or reset the password for an agency user who has been invited to join the agency. The request must contain the invitation token and the new password details. {token* ,password*} A JSON response indicating the result of the operation. Returns: A 200 OK response with an if the password is set successfully. A 400 Bad Request response if the input model is invalid or an error occurs.

resend client invitation email.

{IsSuperAdmin,Id} IsSuperAdmin = Pass true when api call from superadmin panel and pass agency id in Id

And pass false when api call from Agency Panel

Retrieves the list of Agency User with optional filtering, sorting, and pagination.

Retrieves Agency user details by its Id.

{requestId*}

Adds a new Agency user entry.

{FirstName* ,LastName* ,Email* ,Phone* ,RoleId* }

Updates an existing Agency User entry.

{Id* ,FirstName* ,LastName* ,Email* ,Phone* ,RoleId* }

Delete Agency User entry by its Id.

{requestId*}

update agency user status

{Id* ,Staus* } Status:{ Inactive= 0 ,Active= 1, Delete=2}

Retrieves Admin Profile details by its Id.

Change user password.

Retrieves the list of Caregivers

Update caregiver approval status (Pending/Approve/Reject). When Reject, ApprovalReason should be provided.

Update caregiver agency-specific status (Active/Inactive). If Inactive, a reason is required. Cannot set to Inactive when caregiver has upcoming meetings.

Delete caregiver association for a particular agency. Mirrors DeleteAgencyUser pattern. Request uses RequestIdModel.RequestId which should be the CaregiversAssociatedAgency.Id

Get caregiver details by caregiver Id for the current agency. Request.RequestId should be the Caregiver.Id

Get caregiver availability in Day and Hours format (e.g. Monday : 9:00 AM to 3:00 PM) Request.RequestId should be the Caregiver.Id

Get caregiver details by unique identifier (UniqueId). Request model: RequestUniqueIdModel.UniqueId

Associate an existing caregiver with the current agency. Request.RequestId should be the Caregiver.Id

Send invitation code to a caregiver by email. Request model: RequestEmailModel.Email

Search caregivers by email (partial or full) and return matching caregivers. Request model: RequestEmailModel.Email

Export caregiver data to Excel or CSV format with sorting and filtering.

DataSourceRequestModel with optional filters and sorting. File content as byte array.

Get Paired Client List. Request.RequestId should be the CaregiverId

Get all meetings for the agency.

Get meeting details by Id for the agency.

Export meeting data to Excel or CSV format.

ExportMeetingDataRequestModel with filters. File content as byte array.

Get Caregiver profile details by user id.

Update caregiver user profile details by user id.

agesWorked pass value like {"agesWorked": [1, 2, 3]}

Update caregiver profile image.

Request containing imageName.

Change user password.

Registration the specified Caregiver Agency.

The object.

Retrieves the list of documents for Caregiver.

Add [Upload] New documents for Caregiver.

DocumentType { CPRAEDFirstAid = 1,ABA = 2,SpecEdTeacher = 3,RBT = 4,Other = 101} >

Delete documents for Caregiver.

Update Availability for Caregiver ScheduleType.

ScheduleType = {SpecificSchedule = 1,FlexibleSchedule = 2} Days = { Monday = 1,Tuesday = 2,Wednesday = 3,Thursday = 4,Friday = 5,Saturday = 6,Sunday = 7} StartTime and EndTime format should be HH:mm [24 Hours Format] if ScheduleType is FlexibleSchedule then pass only TotalHoursPerWeek if ScheduleType is SpecificSchedule then pass only Days with StartTime and EndTime ProfileType = { Independent = 1, Associated = 2}

Check status Of agency connection.

Submit Agency Connection for Caregiver

Pass AgencyId as Agency Connection

Get support tickets list for the caregiver.

Get support ticket details by Id for the caregiver.

Edit support ticket by caregiver (only when status is pending).

Create support ticket by caregiver.

Delete support ticket by caregiver (only when status is pending).

Caregiver able to set meeting directly for client

The object.

Caregiver view client profile

The object.

Caregiver Set Favorite Client

The object. Pass ClientId

Retrieves the list of Agency with optional filtering, sorting, and pagination.

ApprovalStatus = {Pending = 0,Approve = 1, Reject = 2}

Get the list of completed meetings for the caregiver.

Get meeting details by meeting Id.

Get the list of upcoming meetings for the caregiver.

Caregiver checks in to a meeting.

Caregiver checks out of a meeting.

Caregiver cancels a meeting with a required note.

Add caregiver notes to a meeting.

MeetingNoteType 1= Normal Note, 2 = Reschedule Note

Reschedule a meeting (change date, start time, and end time).

Get List Pair a caregiver with a client.

Pair a caregiver with a client.

ClientPairingStatus = {Paired =1, UnPaired = 2}

Caregiver accepts a meeting.

Caregiver declines a meeting with a required note.

Caregiver delete account

Get Caregiver Associated Agencies

Open To Work for Caregiver Toggle On / Off

Caregiver Toggle On/Off Pass Status true / False

Logout Caregiver

Send Stripe Payment Link Via Email

{RequestId = selected package id }

Reend checkr invitation

{RequestId = selected package id }

Get caregiver activation details

Get caregiver status setting data

Update Independent Caregiver Status toggle on/off

Authenticate and signs in the specified Caregiver.

The object. DeviceType { Android = 1,iOS = 2}

Registration the specified Caregiver.

The object.

This API will be used for activating Caregiver

{email* ,verificationCode*}

This API will be used to resend activation code or sending Password Reset Code for forgot password

{email* ,verificationCodeType* } VerificationCodeType = {Activation = 1,ResetPassword = 2} resend code sent

This API will be used to reset password

{email* ,verificationCode* ,password*} Reset Password response

Retrieves the list of Agency for Caregiver.

Search with Agency Name, City, State

use for get search criteria details for client

get caregiver list as per search criteria

{Distance ,ScheduleType* ,WeeklyHours ,AvailabilityList ,PageSize* ,PageNumber* ,Experience ,SortBy} Scheduletype = { SpecificSchedule = 1,FlexibleSchedule = 2}

TimeZoneType = { ByCurrentLocation = 1,ByAddress = 2,ByZipCode = 3 }

SortBy = { hourlyrate = 1, distance = 2, experience = 3}

Get Client profile details by user id.

Update client user profile details by user id.

EquipmentId pass value like {"agesWorked": [1, 2, 3]}

Update client profile image.

Request containing imageName.

Change user password.

Get the specified Client Agency using Code.

The object.

Submit the specified Client as AssociatedAgency.

The object. Pass parameteras AgencyId

Registration the specified Client Agency.

The object.

Retrieves the list of Agency with optional filtering, sorting, and pagination for client.

ApprovalStatus = {Pending = 0, Approve = 1, Reject = 2}

Get the specified Client Responsible Party.

The object.

Registration the specified Client Responsible Party.

The object.

Get the specified Client Responsible PartyById.

The object.

Update the specified Client Responsible Party.

The object.

Delete the specified Client Responsible Party.

The object.

Client able to set meeting directly for caregiver

The object.

Client view caregiver profile

The object.

Client Set Favorite Caregiver

The object. Pass CaregiverId

Get the list of support tickets for the client.

Get a specific support ticket by its ID.

Create a new support ticket.

Edit an existing support ticket.

Delete a support ticket.

Update Availability for Client ScheduleType.

Get the list of requested meetings for the client.

Get the list of completed meetings for the client.

Get meeting details by meeting Id.

Get the list of upcoming meetings for the client.

Client cancels a meeting with a required note.

Add client notes to a meeting.

MeetingNoteType 1= Normal Note, 2 = Reschedule Note

Reschedule a meeting (change date, start time, and end time).

Get List Pair a client with a caregiver.

Pair a client with a caregiver.

IsPaired = {Paired =1, UnPaired = 2}

Client accepts a meeting.

Client declines a meeting with a required note.

Client delete account

Get Client Associated Agencies

Looking for Caregiver Toggle On / Off api

Caregiver Toggle On/Off Pass Status true / False

Logout Client

Get favorite caregivers for the client.

Get client status setting data

Authenticate and signs in the specified Client.

The object. DeviceType { Android = 1,iOS = 2}

This API will be used for activating Client

{email* ,verificationCode*}

This API will be used to resend activation code or sending Password Reset Code for forgot password

{email* ,verificationCodeType* } VerificationCodeType = {Activation = 1,ResetPassword = 2} resend code sent

This API will be used to Reset password

{email* ,verificationCode* ,password*} Reset Password response

Registration the specified Client.

The object.

Sets the password for an invited client user.

This endpoint is used to set or reset the password for an client user who has been invited to join the client. The request must contain the invitation token and the new password details. {token* ,password*} A JSON response indicating the result of the operation. Returns: A 200 OK response with an if the password is set successfully. A 400 Bad Request response if the input model is invalid or an error occurs.

resend client invitation email.

{requestId}

use for get caregiver search criteria details

get client list as per search criteria

{Distance ,ScheduleType* ,WeeklyHours ,AvailabilityList ,PageSize* ,PageNumber*} Scheduletype = { SpecificSchedule = 1,FlexibleSchedule = 2}

TimeZoneType = { ByCurrentLocation = 1,ByAddress = 2,ByZipCode = 3 }

SortBy = { distance = 2}

Add / Update Client PurchaseToken for Subscription plan.

Pass PurchaseToken and DeviceType ( Android = 1, iOS = 2)

Get Client detail from PurchaseToken.

When you pass Other Client PurchaseToken then return ClientDetils and pass null PurchaseToken then return SubscriptionPlanDetails for Current Client

Get Client Subscription Plan status.

Get Master Dropdown Lists

TypeIds = { StatusList = 0, AdminRoleList = 1,AgencyRoleList = 2, GenderList = 3,AgencyLeadList = 4, ApprovalStatusList = 5, MeetingStatusList = 6, AgeGroupList = 7, CountryList = 8, CaregiverDocTypeList = 9, CommunicationStyleList = 10, AdaptiveEquipmentList = 11, MeetingRequestTypeList = 12, SupportTicketStatusList = 13, CaregiverApprovalStatusList = 14, UserTypeList=15, ProfileTypeList=16, SubscriptionStatusList=17, CheckrStatusForAdminList=18}

Get state list by country id for dropdown

If the provided country id is 0 or null, then it will return the US country's state list.

Check invitation already accept or not for all admin,agency and client

UserType = {Client = 2, Agency = 3,SuperAdmin = 4}

you can get Invitation status in Response { Pending = 0, Accepted = 1, Revoked = 2, Expired = 3} {UserType* ,Token*}

Sample file for caregiver and client data import Excel or CSV format.

UserType = {Caregiver =1,Client = 2} File content as byte array.

Get Notification Lists

UserType = { Caregiver = 1,Client = 2,Agency = 3,SuperAdmin = 4 }

Mark as read Notification

Delete Notification

Single and Bulk Delete Notification

Delete All Notification