👤 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
chevron-right
200Success
application/json
get
/api/v1.0/me/

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
chevron-right
200Success
application/json
put
/api/v1.0/me/

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
chevron-right
200Success
application/json
patch
/api/v1.0/me/

Last updated