Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

👤 User Profile

Authenticated user profile and personal information

Get your profile details

get
/api/v1.0/me/

Retrieve the authenticated user's full profile information.

Authorizations
sessionidstringRequired
Responses
200Success
application/json

Person model with nested user information and related data. Supports reading + writing nested Address/Employee/Banking.

unique_idstring · max: 100 · nullableOptional
current_languagestring · enumOptional
  • en - English
  • sw - Swahili
  • de - German
  • es - Spanish
  • hi - Hindi
  • ar - Arabic
  • ko - Korean
  • pt - Portuguese
  • af - Afrikaans
  • el - Greek
  • fr - French
  • ta - Tamil
  • ru - Russian
  • zh-hans - Simplified Chinese
Possible values:
language_displaystringRead-onlyRequired
profile_picture_urlstring · uri · nullableRead-onlyRequired
job_titlestring · max: 300 · nullableOptional
is_ownerbooleanOptional
user_typestring · enumOptional
  • user - Regular User
  • employee - Employee
Possible values:
user_type_displaystringRead-onlyRequired
last_loginstring · date-time · nullableOptional
date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
get/api/v1.0/me/
GET /api/v1.0/me/ HTTP/1.1
Host: skhokho.ai
Accept: */*

{
  "unique_id": "text",
  "user": {
    "first_name": "text",
    "last_name": "text",
    "email": "name@gmail.com"
  },
  "current_language": "en",
  "language_display": "text",
  "profile_picture_url": "https://example.com",
  "job_title": "text",
  "is_owner": true,
  "user_type": "user",
  "user_type_display": "text",
  "organisation_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "address": {
    "address_line_1": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country_name": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number_last4": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text",
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z",
    "account_type_display": "text"
  },
  "employee_information": {
    "id_number": "text",
    "employee_number": "text",
    "tax_number": "text",
    "phone_number": "text",
    "birthday": "2026-01-01",
    "linkedin_url": "https://example.com",
    "emergency_contact": "text",
    "emergency_phone": "text",
    "medical_aid_number": "text",
    "medical_aid_provider": "text",
    "medical_aid_plan": "text",
    "medical_conditions": "text",
    "allergies": "text",
    "medications": "text",
    "start_date": "2026-01-01",
    "end_date": "2026-01-01",
    "is_active_employee": true,
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z"
  },
  "last_login": "2026-01-01T00:00:00.000Z",
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Update your profile (full)

put
/api/v1.0/me/

Replace the authenticated user's profile with the provided payload. All writable fields must be supplied.

Authorizations
sessionidstringRequired
Body

Person model with nested user information and related data. Supports reading + writing nested Address/Employee/Banking.

unique_idstring · max: 100 · nullableOptional
current_languagestring · enumOptional
  • en - English
  • sw - Swahili
  • de - German
  • es - Spanish
  • hi - Hindi
  • ar - Arabic
  • ko - Korean
  • pt - Portuguese
  • af - Afrikaans
  • el - Greek
  • fr - French
  • ta - Tamil
  • ru - Russian
  • zh-hans - Simplified Chinese
Possible values:
job_titlestring · max: 300 · nullableOptional
is_ownerbooleanOptional
user_typestring · enumOptional
  • user - Regular User
  • employee - Employee
Possible values:
last_loginstring · date-time · nullableOptional
date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
Responses
200Success
application/json

Person model with nested user information and related data. Supports reading + writing nested Address/Employee/Banking.

unique_idstring · max: 100 · nullableOptional
current_languagestring · enumOptional
  • en - English
  • sw - Swahili
  • de - German
  • es - Spanish
  • hi - Hindi
  • ar - Arabic
  • ko - Korean
  • pt - Portuguese
  • af - Afrikaans
  • el - Greek
  • fr - French
  • ta - Tamil
  • ru - Russian
  • zh-hans - Simplified Chinese
Possible values:
language_displaystringRead-onlyRequired
profile_picture_urlstring · uri · nullableRead-onlyRequired
job_titlestring · max: 300 · nullableOptional
is_ownerbooleanOptional
user_typestring · enumOptional
  • user - Regular User
  • employee - Employee
Possible values:
user_type_displaystringRead-onlyRequired
last_loginstring · date-time · nullableOptional
date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
put/api/v1.0/me/
PUT /api/v1.0/me/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 927

{
  "unique_id": "text",
  "current_language": "en",
  "job_title": "text",
  "is_owner": true,
  "user_type": "user",
  "address": {
    "address_line_1": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  },
  "employee_information": {
    "id_number": "text",
    "employee_number": "text",
    "tax_number": "text",
    "phone_number": "text",
    "birthday": "2026-01-01",
    "linkedin_url": "https://example.com",
    "emergency_contact": "text",
    "emergency_phone": "text",
    "medical_aid_number": "text",
    "medical_aid_provider": "text",
    "medical_aid_plan": "text",
    "medical_conditions": "text",
    "allergies": "text",
    "medications": "text",
    "start_date": "2026-01-01",
    "end_date": "2026-01-01",
    "is_active_employee": true
  },
  "last_login": "2026-01-01T00:00:00.000Z",
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}
{
  "unique_id": "text",
  "user": {
    "first_name": "text",
    "last_name": "text",
    "email": "name@gmail.com"
  },
  "current_language": "en",
  "language_display": "text",
  "profile_picture_url": "https://example.com",
  "job_title": "text",
  "is_owner": true,
  "user_type": "user",
  "user_type_display": "text",
  "organisation_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "address": {
    "address_line_1": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country_name": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number_last4": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text",
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z",
    "account_type_display": "text"
  },
  "employee_information": {
    "id_number": "text",
    "employee_number": "text",
    "tax_number": "text",
    "phone_number": "text",
    "birthday": "2026-01-01",
    "linkedin_url": "https://example.com",
    "emergency_contact": "text",
    "emergency_phone": "text",
    "medical_aid_number": "text",
    "medical_aid_provider": "text",
    "medical_aid_plan": "text",
    "medical_conditions": "text",
    "allergies": "text",
    "medications": "text",
    "start_date": "2026-01-01",
    "end_date": "2026-01-01",
    "is_active_employee": true,
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z"
  },
  "last_login": "2026-01-01T00:00:00.000Z",
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Update your profile (partial)

patch
/api/v1.0/me/

Partially update the authenticated user's profile. Only include the fields that should change.

Authorizations
sessionidstringRequired
Body

Person model with nested user information and related data. Supports reading + writing nested Address/Employee/Banking.

unique_idstring · max: 100 · nullableOptional
current_languagestring · enumOptional
  • en - English
  • sw - Swahili
  • de - German
  • es - Spanish
  • hi - Hindi
  • ar - Arabic
  • ko - Korean
  • pt - Portuguese
  • af - Afrikaans
  • el - Greek
  • fr - French
  • ta - Tamil
  • ru - Russian
  • zh-hans - Simplified Chinese
Possible values:
job_titlestring · max: 300 · nullableOptional
is_ownerbooleanOptional
user_typestring · enumOptional
  • user - Regular User
  • employee - Employee
Possible values:
last_loginstring · date-time · nullableOptional
date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
Responses
200Success
application/json

Person model with nested user information and related data. Supports reading + writing nested Address/Employee/Banking.

unique_idstring · max: 100 · nullableOptional
current_languagestring · enumOptional
  • en - English
  • sw - Swahili
  • de - German
  • es - Spanish
  • hi - Hindi
  • ar - Arabic
  • ko - Korean
  • pt - Portuguese
  • af - Afrikaans
  • el - Greek
  • fr - French
  • ta - Tamil
  • ru - Russian
  • zh-hans - Simplified Chinese
Possible values:
language_displaystringRead-onlyRequired
profile_picture_urlstring · uri · nullableRead-onlyRequired
job_titlestring · max: 300 · nullableOptional
is_ownerbooleanOptional
user_typestring · enumOptional
  • user - Regular User
  • employee - Employee
Possible values:
user_type_displaystringRead-onlyRequired
last_loginstring · date-time · nullableOptional
date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
patch/api/v1.0/me/
PATCH /api/v1.0/me/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 927

{
  "unique_id": "text",
  "current_language": "en",
  "job_title": "text",
  "is_owner": true,
  "user_type": "user",
  "address": {
    "address_line_1": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text"
  },
  "employee_information": {
    "id_number": "text",
    "employee_number": "text",
    "tax_number": "text",
    "phone_number": "text",
    "birthday": "2026-01-01",
    "linkedin_url": "https://example.com",
    "emergency_contact": "text",
    "emergency_phone": "text",
    "medical_aid_number": "text",
    "medical_aid_provider": "text",
    "medical_aid_plan": "text",
    "medical_conditions": "text",
    "allergies": "text",
    "medications": "text",
    "start_date": "2026-01-01",
    "end_date": "2026-01-01",
    "is_active_employee": true
  },
  "last_login": "2026-01-01T00:00:00.000Z",
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}
{
  "unique_id": "text",
  "user": {
    "first_name": "text",
    "last_name": "text",
    "email": "name@gmail.com"
  },
  "current_language": "en",
  "language_display": "text",
  "profile_picture_url": "https://example.com",
  "job_title": "text",
  "is_owner": true,
  "user_type": "user",
  "user_type_display": "text",
  "organisation_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "address": {
    "address_line_1": "text",
    "city": "text",
    "province_state": "text",
    "postal_code": "text",
    "country_name": "text"
  },
  "banking_information": {
    "bank_name": "text",
    "account_number_last4": "text",
    "branch_code": "text",
    "account_type": "checking",
    "routing_number": "text",
    "swift_code": "text",
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z",
    "account_type_display": "text"
  },
  "employee_information": {
    "id_number": "text",
    "employee_number": "text",
    "tax_number": "text",
    "phone_number": "text",
    "birthday": "2026-01-01",
    "linkedin_url": "https://example.com",
    "emergency_contact": "text",
    "emergency_phone": "text",
    "medical_aid_number": "text",
    "medical_aid_provider": "text",
    "medical_aid_plan": "text",
    "medical_conditions": "text",
    "allergies": "text",
    "medications": "text",
    "start_date": "2026-01-01",
    "end_date": "2026-01-01",
    "is_active_employee": true,
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z"
  },
  "last_login": "2026-01-01T00:00:00.000Z",
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}
Previous👤 Profile
Next🏢 Organization

Last updated