Zoho: Users schemas
6 Zoho schemas with complete fields and constraints.
← Users operations · All schemas
Create User — request body — body users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the user details object used to create or update a Zoho CRM user, including personal information, preferences, role, profile, and account settings. Additional keys: allowed |
$current_shift | JSON | Optional | Specify the current shift assigned to the user. Set to null to clear the assigned shift. |
$current_shift (anyOf 1) | object | Alternative | Represents the current shift object with the shift ID and display name to assign to the user. Additional keys: not allowed |
$current_shift (anyOf 1).id | string | Required within parent | Specify the unique ID of the shift to assign as the current shift. Maximum length: 19 Pattern: ^[0-9]+$ |
$current_shift (anyOf 1).name | string | Required within parent | Specify the display name of the shift to assign as the current shift. Maximum length: 80 |
$current_shift (anyOf 2) | null | Alternative | Indicates that no current shift is assigned to the user. |
$next_shift | JSON | Optional | Specify the upcoming shift to be assigned to the user. Set to null to clear the upcoming shift. |
$next_shift (anyOf 1) | object | Alternative | Represents the upcoming shift object with the shift ID and display name to assign to the user. Additional keys: not allowed |
$next_shift (anyOf 1).id | string | Required within parent | Specify the unique ID of the shift to assign as the upcoming shift. Format: int64 Maximum length: 100 Pattern: ^[0-9]+$ |
$next_shift (anyOf 1).name | string | Required within parent | Specify the display name of the shift to assign as the upcoming shift. Maximum length: 80 |
$next_shift (anyOf 2) | null | Alternative | Indicates that no upcoming shift is assigned to the user. |
$shift_effective_from | JSON | Optional | Specify the date on which the upcoming shift assignment becomes effective. |
$shift_effective_from (anyOf 1) | string | Alternative | Represents the date on which the upcoming shift assignment becomes effective. Format: date Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
$shift_effective_from (anyOf 2) | null | Alternative | Indicates that no upcoming shift effective date is set. |
Reporting_To | JSON | Optional | Specify the user to whom this user reports. Set to null to remove the reporting relationship. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for valid user IDs. |
Reporting_To (anyOf 1) | object | Alternative | Represents the reporting manager object with the manager user ID and name. Additional keys: not allowed |
Reporting_To (anyOf 1).id | string | Required within parent | Specify the unique ID of the user to assign as the reporting manager. Maximum length: 19 |
Reporting_To (anyOf 1).name | string | Required within parent | Specify the full name of the user to assign as the reporting manager. Maximum length: 100 |
Reporting_To (anyOf 2) | null | Alternative | Indicates that no reporting manager is assigned to this user. |
alias | JSON | Optional | Specify an alias or short name for the user. Set to null to remove an existing alias. |
alias (anyOf 1) | string | Alternative | Represents the alias or short name to assign to the user. Maximum length: 50 |
alias (anyOf 2) | null | Alternative | Indicates that no alias is set for the user. |
city | JSON | Optional | Specify the city for the user's address. Set to null to clear an existing city value. |
city (anyOf 1) | string | Alternative | Represents the city value to set for the user. Maximum length: 100 |
city (anyOf 2) | null | Alternative | Indicates that the city value should be cleared. |
country | JSON | Optional | Specify the country for the user's address. Set to null to clear an existing country value. |
country (anyOf 1) | string | Alternative | Represents the country value to set for the user. Maximum length: 100 |
country (anyOf 2) | null | Alternative | Indicates that the country value should be cleared. |
country_locale | string | Optional | Specify the locale associated with the user's country. One of: ps_AF, sv_AX, sq_AL, ar_DZ, en_AS, ca_AD, pt_AO, en_AI, en_AQ, en_AG, es_AR, hy_AM, nl_AW, en_AU, de_AT, az_AZ, en_BS, ar_BH, bn_BD, en_BB, be_BY, nl_BE, fr_BE, en_BZ, fr_BJ, en_BM, en_BT, es_BO, bs_BA, en_BW, no_BV, pt_BR, en_IO, en_VG, ms_BN, bg_BG, fr_BF, fr_BI, km_KH, fr_CM, en_CA, fr_CA, pt_CV, en_KY, fr_CF, ar_TD, es_CL, zh_CN, en_CX, en_CC, es_CO, fr_KM, en_CK, es_CR, hr_HR, es_CU, el_CY, cs_CZ, fr_CD, da_DK, ar_DJ, en_DM, es_DO, es_EC, ar_EG, es_SV, es_GQ, en_ER, et_EE, en_SZ, am_ET, en_FK, fo_FO, fj_FJ, fi_FI, fr_FR, fr_GF, fr_PF, fr_TF, fr_GA, en_GM, ka_GE, de_DE, en_GH, en_GI, el_GR, kl_GL, en_GD, fr_GP, en_GU, es_GT, fr_GN, pt_GW, en_GY, fr_HT, en_HM, es_HN, zh_HK, hu_HU, is_IS, en_IN, id_ID, fa_IR, ar_IQ, en_IE, iw_IL, it_IT, en_JM, ja_JP, ar_JO, ru_KZ, sw_KE, en_KI, ar_KW, uz_KG, lo_LA, lv_LV, ar_LB, en_LS, en_LR, ar_LY, de_LI, lt_LT, fr_LU, de_LU, zh_MO, en_MG, en_MW, ms_MY, dv_MV, fr_ML, mt_MT, en_MH, fr_MQ, ar_MR, en_MU, fr_YT, es_MX, en_FM, ro_MD, fr_MC, mn_MN, sr_ME, en_MS, ar_MA, pt_MZ, my_MM, en_NA, en_NR, ne_NP, nl_NL, nl_AN, fr_NC, en_NZ, es_NI, fr_NE, en_NG, en_NU, en_NF, ko_KP, mk_MK, en_MP, no_NO, ar_OM, en_PK, en_PW, ar_PS, es_PA, en_PG, es_PY, es_PE, en_PH, en_PN, pl_PL, pt_PT, es_PR, ar_QA, fr_CG, fr_RE, ro_RO, ru_RU, rw_RW, en_SH, en_KN, en_LC, fr_PM, en_VC, en_WS, it_SM, pt_ST, ar_SA, fr_SN, sr_RS, sr_CS, en_SC, en_SL, en_SG, sk_SK, sl_SI, en_SB, so_SO, en_ZA, en_GS, ko_KR, es_ES, si_LK, ar_SD, nl_SR, no_SJ, sv_SE, fr_CH, de_CH, it_CH, ar_SY, zh_TW, fa_TJ, sw_TZ, th_TH, pt_TL, fr_TG, en_TK, to_TO, en_TT, ar_TN, tr_TR, tk_TM, en_TC, en_TV, en_UG, uk_UA, ar_AE, en_GB, en_US, en_UM, es_UY, uz_UZ, bi_VU, it_VA, es_VE, vi_VN, en_VI, fr_WF, ar_EH, ar_YE, en_ZM, en_ZW, fr_CI |
customize_info | object | Optional | Specify user interface customization preferences for the user's account. Additional keys: allowed |
customize_info.notes_desc | boolean | Optional | Specify whether notes should be displayed in descending order for the user.\n\nPossible values:\ntrue - Notes are displayed in descending order.\nfalse - Notes are not displayed in descending order. |
customize_info.show_detail_view | boolean | Optional | Specify whether the detail view panel is displayed for the user.\n\nPossible values:\ntrue - The detail view panel is displayed.\nfalse - The detail view panel is not displayed. |
customize_info.show_left_panel | boolean | Optional | Specify whether the left panel is displayed in the user interface.\n\nPossible values:\ntrue - The left panel is shown.\nfalse - The left panel is hidden. |
date_format | string | Optional | Specify the user's preferred date format for displaying date values. One of: dd-MM-yyyy, dd/MM/yyyy, dd.MM.yyyy, dd MM yyyy, dd-MM-yy, dd/MM/yy, dd.MM.yy, d.MM.yy, d-M-yy, d/M/yy, d.M.yy, d.M.yy., d-M-yyyy, d/M/yyyy, d.M.yyyy, d. M. yyyy., d. M. yyyy, d MMM, yyyy, dd MMM, yyyy, d. MMMM yyyy, dd.MM.yyyy., dd.MM.yy., yyyy-MM-dd, yyyy/MM/dd, yyyy.MM.dd, yyyy MM dd, yy/MM/dd, yy-MM-dd, yy.M.d, yy-M-d, yy. M. d, yyyy/M/d, yyyy年MM月dd日, yy年M月d日, yyyy.MM.dd., yyyy. MM. dd, MM-dd-yyyy, MM/dd/yyyy, MM.dd.yyyy, MM dd yyyy, MM-dd-yy, MM/dd/yy, M/dd/yy, MMM-dd-yyyy, MMM dd, yyyy, MMM d, yyyy, MMMM d, yyyy, yyyy.dd.MM, yy.d.M |
decimal_separator | string | Optional | Specify the user's preferred decimal separator character for displaying numerical values. One of: Comma, Period |
default_tab_group | integer | Optional | Specify the default tab group for the user, determining which group of tabs is shown upon login. Format: int32 |
distance_preference__s | string | Optional | Specify the user's preferred unit of measurement for displaying distance values. One of: Kilometers, Miles |
dob | JSON | Optional | Specify the user's date of birth in YYYY-MM-DD format. Set to null to clear an existing date of birth. |
dob (anyOf 1) | string | Alternative | Represents the date of birth value in YYYY-MM-DD format to set for the user. Format: date |
dob (anyOf 2) | null | Alternative | Indicates that the date of birth should be cleared. |
email | string | Optional | Specify the email address for the user's account. Maximum length: 100 |
fax | JSON | Optional | Specify the user's fax number. Set to null to clear an existing fax number. |
fax (anyOf 1) | string | Alternative | Represents the fax number to set for the user. Maximum length: 30 |
fax (anyOf 2) | null | Alternative | Indicates that the fax number should be cleared. |
first_name | string | Optional | Specify the user's first name. Maximum length: 50 |
full_name | string | Optional | Specify the user's full name. Maximum length: 100 Read only: true |
id | string | Optional | Represents the unique identifier of the user record. Maximum length: 19 Read only: true |
image_link | string | Optional | Specify the URL of the user's profile image from the Identity and Access Management (IAM) system. Maximum length: 100 |
language | string | Optional | Specify the preferred language for the user. This value can be updated only by the user themselves. One of: af_NA, af_ZA, ak_GH, su_ID, cy_GB, de_CH, de_AT, en_AU, en_CA, en_IE, en_NZ, en_SG, en_ZA, ee_GH, ee_TG, fy_NL, ga_GB, ga_IE, gv_IM, ki_KE, gd_GB, ha_GH, ha_NG, ha_NE, ig_NG, rn_BI, jv_ID, rw_RW, sw_CD, sw_KE, sw_TZ, sw_UG, lg_UG, lb_LU, mg_MG, mt_MT, ms_BN, ms_ID, ms_MY, ms_SG, nl_BE, nl_BQ, om_ET, om_KE, ff_GN, ff_SN, qu_BO, qu_EC, qu_PE, so_ET, so_DJ, so_KE, so_SO, sg_CF, vi_VN, lu_CD, tr_CY, tr_TR, wo_SN, az_AZ, bm_ML, bs_BA, br_FR, ca_AD, ca_ES, ca_FR, ca_IT, sn_ZW, da_DK, da_GL, se_NO, se_SE, se_FI, et_EE, es_AR, es_BO, es_CL, es_CO, es_CR, es_EC, es_SV, es_GT, es_HN, es_NI, es_PA, es_PY, es_PE, es_PR, es_DO, es_UY, es_VE, eu_ES, fr_BE, fr_CA, fr_CH, fo_DK, fo_FO, gl_ES, hr_BA, hr_HR, nd_ZW, xh_ZA, zu_ZA, it_VA, it_IT, it_SM, it_CH, kl_GL, kw_GB, ku_TR, lv_LV, to_TO, lt_LT, ln_AO, ln_CG, ln_CF, ln_CD, hu_HU, nn_NO, no_NO, nb_NO, nb_SJ, uz_AF, uz_UZ, pl_PL, ro_MD, ro_RO, rm_CH, sq_XK, sq_MK, sq_AL, sk_SK, sl_SI, fi_FI, sv_FI, sv_SE, sv_AX, mi_NZ, tk_TM, yo_BJ, yo_NG, is_IS, cs_CZ, el_GR, el_CY, be_BY, bg_BG, os_GE, os_RU, ky_KG, mk_MK, mn_MN, ce_RU, sr_BA, sr_CS, sr_RS, sr_ME, tt_RU, tg_TJ, uk_UA, kk_KZ, hy_AM, ug_CN, ur_IN, ur_PK, ar_JO, ar_AE, ar_BH, ar_DZ, ar_SD, ar_IQ, ar_KW, ar_MA, ar_SA, ar_YE, ar_TN, ar_SY, ar_OM, ar_QA, ar_LB, ar_LY, sd_PK, sd_IN, fa_AF, fa_IR, ps_AF, ps_PK, ks_IN, ne_NP, ne_IN, mr_IN, sa_IN, hi_IN, as_IN, bn_BD, bn_IN, pa_PK, pa_IN, gu_IN, or_IN, ta_IN, ta_LK, ta_SG, ta_MY, te_IN, kn_IN, ml_IN, si_LK, th_TH, lo_LA, bo_IN, bo_CN, dz_BT, my_MM, ka_GE, ti_ET, ti_ER, am_ET, km_KH, zh_MO, zh_HK, zh_SG, zh_CN, zh_TW, ja_JP, ii_CN, ko_KR, ko_KP |
last_name | JSON | Optional | Specify the user's last name. Set to null if no last name is to be stored. |
last_name (anyOf 1) | string | Alternative | Represents the last name to set for the user. Maximum length: 50 |
last_name (anyOf 2) | null | Alternative | Indicates that the last name should be cleared. |
locale | string | Optional | Specify the locale for the user. One of: in_ID, zh_CN, zh_TW, da_DK, de_DE, en_GB, en_US, es_ES, fr_FR, iw_IL, hr_HR, it_IT, hu_HU, nl_NL, pl_PL, pt_BR, pt_PT, sv_SE, vi_VN, tr_TR, cs_CZ, bg_BG, ru_RU, ar_EG, hi_IN, th_TH, ja_JP, ko_KR |
mobile | string or null | Optional | Specify the user's mobile phone number. Set to null to clear an existing mobile number. Maximum length: 30 |
name_format__s | string | Optional | Specify the format to use when displaying the user's name. One of: Salutation,First Name,Last Name, Salutation,Last Name,First Name, First Name,Salutation,Last Name, First Name,Last Name,Salutation, Last Name,Salutation,First Name, Last Name,First Name,Salutation |
number_separator | string | Optional | Specify the character to use as a separator when formatting numbers for the user. This field is case-insensitive. One of: Comma, Period, Space, comma, period, space |
phone | string or null | Optional | Specify the user's phone number. Set to null to clear an existing phone number. Maximum length: 30 |
profile | object | Optional | Specify the profile to assign to the user, including the profile's unique identifier and display name. Additional keys: not allowed |
profile.id | string | Required within parent | Specify the unique ID of the profile to assign to the user. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |
profile.name | string | Required within parent | Specify the display name of the profile to assign to the user. Maximum length: 50 |
role | object | Optional | Specify the role to assign to the user, including the role's unique identifier and display name. Additional keys: not allowed |
role.id | string | Required within parent | Specify the unique ID of the role to assign to the user. Maximum length: 19 |
role.name | string | Required within parent | Specify the display name of the role to assign to the user. Maximum length: 200 |
share_among_subordinates | boolean | Optional | Specify whether the user's records should be shared with their subordinates.\n\nPossible values:\ntrue - Records are shared with subordinates.\nfalse - Records are not shared with subordinates. |
signature | string or null | Optional | Specify the email signature for the user. Set to null to remove an existing signature. Maximum length: 200 |
sort_order_preference__s | string | Optional | Specify the user's preferred sort order for displaying records. One of: First Name,Last Name, Last Name,First Name |
state | JSON | Optional | Specify the state or province for the user's address. Set to null to clear an existing state value. |
state (anyOf 1) | string | Alternative | Represents the state or province to set for the user. Maximum length: 100 |
state (anyOf 2) | null | Alternative | Indicates that the state value should be cleared. |
status | string | Optional | Specify the status of the user account. One of: active, inactive |
street | JSON | Optional | Specify the street address for the user. Set to null to clear an existing street address. |
street (anyOf 1) | string | Alternative | Represents the street address to set for the user. Maximum length: 250 |
street (anyOf 2) | null | Alternative | Indicates that the street address should be cleared. |
theme | object | Optional | Specify the theme configuration for the user's CRM interface, including color and display settings for the background, screen, header, normal tab, and selected tab elements. Read only: true Additional keys: not allowed |
theme.background | string | Optional | Specify the background color for the user's theme. Format: hex-color |
theme.header | object | Optional | Specify the theme settings for the header area of the user's CRM interface, including background color and font color. Additional keys: not allowed |
theme.header.background | string | Optional | Specify the background color for the header area of the user's theme. Format: hex-color |
theme.header.font_color | string | Optional | Specify the font color for the header area of the user's theme. Format: hex-color |
theme.new_background | string or null | Optional | Specify the updated background color for the user's theme. Format: hex-color |
theme.normal_tab | object | Optional | Specify the theme settings for the normal (unselected) tab in the user's CRM interface, including background color and font color. Additional keys: not allowed |
theme.normal_tab.background | string | Optional | Specify the background color for the normal tab in the user's theme. Format: hex-color |
theme.normal_tab.font_color | string | Optional | Specify the font color for the normal tab in the user's theme. Format: hex-color |
theme.screen | string | Optional | Specify the screen type or layout for the user's CRM interface. One of: fixed |
theme.selected_tab | object | Optional | Specify the theme settings for the selected tab in the user's CRM interface, including background color and font color. Additional keys: not allowed |
theme.selected_tab.background | string | Optional | Specify the background color for the selected tab in the user's theme. Format: hex-color |
theme.selected_tab.font_color | string | Optional | Specify the font color for the selected tab in the user's theme. Format: hex-color |
theme.type | string | Optional | Specify the type of theme to apply to the user's CRM interface. One of: default, custom |
time_format | string | Optional | Specify the time format to use for displaying time values for the user. One of: HH:mm, hh:mm a |
time_zone | string | Optional | Specify the time zone for the user. This value can be updated only by the user themselves. Maximum length: 150 |
website | JSON | Optional | Specify the user's website URL. Set to null to clear an existing website URL. |
website (anyOf 1) | string | Alternative | Represents the website URL to set for the user. Maximum length: 250 |
website (anyOf 2) | null | Alternative | Indicates that the website URL should be cleared. |
zip | JSON | Optional | Specify the user's postal code or ZIP code. Set to null to clear an existing postal code. |
zip (anyOf 1) | string | Alternative | Represents the postal code or ZIP code to set for the user. Maximum length: 30 |
zip (anyOf 2) | null | Alternative | Indicates that the postal code should be cleared. |
Get a specific user — response body — users users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of a Zoho CRM user, including personal information, preferences, role, profile, and account settings. Additional keys: allowed |
$current_shift | JSON | Optional | Represents the shift currently assigned to the user, including the shift's ID and name. |
$current_shift (anyOf 1) | object | Alternative | Represents the current shift assigned to the user, identified by its unique ID and display name. Additional keys: not allowed |
$current_shift (anyOf 1).id | string | Required within parent | Represents the unique ID of the user's current shift. Format: int64 |
$current_shift (anyOf 1).name | string | Required within parent | Represents the display name of the user's current shift. Maximum length: 80 |
$current_shift (anyOf 2) | null | Alternative | Indicates that no current shift is assigned to the user. |
$next_shift | JSON | Optional | Represents the upcoming shift scheduled for the user, including the shift's ID and name. |
$next_shift (anyOf 1) | object | Alternative | Represents the upcoming shift assigned to the user, identified by its unique ID and display name. Additional keys: not allowed |
$next_shift (anyOf 1).id | string | Required within parent | Represents the unique ID of the user's upcoming shift. Maximum length: 19 |
$next_shift (anyOf 1).name | string | Required within parent | Represents the display name of the user's upcoming shift. Maximum length: 80 |
$next_shift (anyOf 2) | null | Alternative | Indicates that no upcoming shift is assigned to the user. |
$shift_effective_from | JSON | Optional | Represents the date on which the user's upcoming shift becomes effective. |
$shift_effective_from (anyOf 1) | string | Alternative | Represents the date from which the upcoming shift assignment becomes effective. Format: date Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) |
$shift_effective_from (anyOf 2) | null | Alternative | Indicates that no upcoming shift effective date is set. |
Confirmed_Time__s | JSON | Optional | Represents the date and time at which the user's status was confirmed. Returns null if confirmation has not occurred. Read only: true |
Confirmed_Time__s (anyOf 1) | string | Alternative | Represents the date and time at which the user status was confirmed. Format: date-time |
Confirmed_Time__s (anyOf 2) | null | Alternative | Indicates that no confirmation time is recorded for the user. |
Invited_By__s | JSON | Optional | Represents the user who extended the invitation to this user. Returns null if no inviting user is associated. Read only: true |
Invited_By__s (anyOf 1) | object | Alternative | Represents the user who invited this user, identified by their unique ID and full name. Additional keys: not allowed |
Invited_By__s (anyOf 1).id | string | Required within parent | Represents the unique ID of the user who invited this user. Maximum length: 19 |
Invited_By__s (anyOf 1).name | string | Required within parent | Represents the full name of the user who invited this user. Maximum length: 100 |
Invited_By__s (anyOf 2) | null | Alternative | Indicates that no inviting user is associated with this user. |
Invited_Time__s | JSON | Optional | Represents the date and time at which the most recent invitation was sent to this user. Returns null if no invitation has been sent. Read only: true |
Invited_Time__s (anyOf 1) | string | Alternative | Represents the date and time at which the most recent invitation was sent to this user. Format: date-time Read only: true |
Invited_Time__s (anyOf 2) | null | Alternative | Indicates that no invitation has been sent to this user. |
Modified_By | JSON | Optional | Represents the user who last modified this user record. Returns null if no modification has occurred. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. |
Modified_By (anyOf 1) | object | Alternative | Represents the user who last modified this user record, identified by their unique ID and full name. Additional keys: not allowed |
Modified_By (anyOf 1).id | string | Required within parent | Represents the unique ID of the user who last modified this user record. Maximum length: 19 |
Modified_By (anyOf 1).name | string | Required within parent | Represents the full name of the user who last modified this user record. Maximum length: 100 |
Modified_By (anyOf 2) | null | Alternative | Indicates that no modification has been recorded for this user record. |
Modified_Time | JSON | Optional | Represents the date and time at which this user record was last modified, in ISO 8601 format. Returns null if no modification has occurred. |
Modified_Time (anyOf 1) | string | Alternative | Represents the date and time at which this user record was last modified. Format: date-time Read only: true |
Modified_Time (anyOf 2) | null | Alternative | Indicates that no modification time is recorded for this user record. |
Reporting_To | JSON | Optional | Represents the user to whom this user reports within the organizational hierarchy. Returns null if no reporting manager is assigned. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. |
Reporting_To (anyOf 1) | object | Alternative | Represents the user to whom this user reports, identified by their unique ID and full name. Additional keys: not allowed |
Reporting_To (anyOf 1).id | string | Required within parent | Represents the unique ID of the user to whom this user reports. Maximum length: 19 |
Reporting_To (anyOf 1).name | string | Required within parent | Represents the full name of the user to whom this user reports. Maximum length: 100 |
Reporting_To (anyOf 2) | null | Alternative | Indicates that no reporting manager is assigned to this user. |
Status_Updated_By__s | JSON | Optional | Represents the details of the user who last updated the status of this user. Returns null if no status update has been recorded. Read only: true |
Status_Updated_By__s (anyOf 1) | object | Alternative | Represents the user who last updated the status of this user, identified by their unique ID and full name. Additional keys: not allowed |
Status_Updated_By__s (anyOf 1).id | string | Required within parent | Represents the unique ID of the user who last updated the status of this user. Maximum length: 19 |
Status_Updated_By__s (anyOf 1).name | string | Required within parent | Represents the full name of the user who last updated the status of this user. Maximum length: 100 |
Status_Updated_By__s (anyOf 2) | null | Alternative | Indicates that no status update has been recorded for this user. |
Status_Updated_Time__s | string | Optional | Represents the date and time at which the status of this user was last updated. Format: date-time Read only: true |
alias | JSON | Optional | Represents the alias or short name associated with the user. Returns null if no alias is configured. |
alias (anyOf 1) | string | Alternative | Represents the alias or short name associated with the user. Maximum length: 50 |
alias (anyOf 2) | null | Alternative | Indicates that no alias is configured for the user. |
city | JSON | Optional | Represents the city associated with the user's address. Returns null if no city is configured. |
city (anyOf 1) | string | Alternative | Represents the city associated with the user. Maximum length: 100 |
city (anyOf 2) | null | Alternative | Indicates that no city is configured for the user. |
confirm | boolean | Optional | Indicates whether the user has accepted the invitation to join the organization.\n\nPossible values:\ntrue - The user has accepted the invitation.\nfalse - The user has not yet accepted the invitation. Read only: true |
country | JSON | Optional | Represents the country associated with the user's address. Returns null if no country is configured. |
country (anyOf 1) | string | Alternative | Represents the country associated with the user. Maximum length: 100 |
country (anyOf 2) | null | Alternative | Indicates that no country is configured for the user. |
country_locale | string | Optional | Represents the locale associated with the user's country. Known values: ps_AF, sv_AX, sq_AL, ar_DZ, en_AS, ca_AD, pt_AO, en_AI, en_AQ, en_AG, es_AR, hy_AM, nl_AW, en_AU, de_AT, az_AZ, en_BS, ar_BH, bn_BD, en_BB, be_BY, nl_BE, fr_BE, en_BZ, fr_BJ, en_BM, en_BT, es_BO, bs_BA, en_BW, no_BV, pt_BR, en_IO, en_VG, ms_BN, bg_BG, fr_BF, fr_BI, km_KH, fr_CM, en_CA, fr_CA, pt_CV, en_KY, fr_CF, ar_TD, es_CL, zh_CN, en_CX, en_CC, es_CO, fr_KM, en_CK, es_CR, hr_HR, es_CU, el_CY, cs_CZ, fr_CD, da_DK, ar_DJ, en_DM, es_DO, es_EC, ar_EG, es_SV, es_GQ, en_ER, et_EE, en_SZ, am_ET, en_FK, fo_FO, fj_FJ, fi_FI, fr_FR, fr_GF, fr_PF, fr_TF, fr_GA, en_GM, ka_GE, de_DE, en_GH, en_GI, el_GR, kl_GL, en_GD, fr_GP, en_GU, es_GT, fr_GN, pt_GW, en_GY, fr_HT, en_HM, es_HN, zh_HK, hu_HU, is_IS, en_IN, id_ID, fa_IR, ar_IQ, en_IE, iw_IL, it_IT, en_JM, ja_JP, ar_JO, ru_KZ, sw_KE, en_KI, ar_KW, uz_KG, lo_LA, lv_LV, ar_LB, en_LS, en_LR, ar_LY, de_LI, lt_LT, fr_LU, de_LU, zh_MO, en_MG, en_MW, ms_MY, dv_MV, fr_ML, mt_MT, en_MH, fr_MQ, ar_MR, en_MU, fr_YT, es_MX, en_FM, ro_MD, fr_MC, mn_MN, sr_ME, en_MS, ar_MA, pt_MZ, my_MM, en_NA, en_NR, ne_NP, nl_NL, nl_AN, fr_NC, en_NZ, es_NI, fr_NE, en_NG, en_NU, en_NF, ko_KP, mk_MK, en_MP, no_NO, ar_OM, en_PK, en_PW, ar_PS, es_PA, en_PG, es_PY, es_PE, en_PH, en_PN, pl_PL, pt_PT, es_PR, ar_QA, fr_CG, fr_RE, ro_RO, ru_RU, rw_RW, en_SH, en_KN, en_LC, fr_PM, en_VC, en_WS, it_SM, pt_ST, ar_SA, fr_SN, sr_RS, sr_CS, en_SC, en_SL, en_SG, sk_SK, sl_SI, en_SB, so_SO, en_ZA, en_GS, ko_KR, es_ES, si_LK, ar_SD, nl_SR, no_SJ, sv_SE, fr_CH, de_CH, it_CH, ar_SY, zh_TW, fa_TJ, sw_TZ, th_TH, pt_TL, fr_TG, en_TK, to_TO, en_TT, ar_TN, tr_TR, tk_TM, en_TC, en_TV, en_UG, uk_UA, ar_AE, en_GB, en_US, en_UM, es_UY, uz_UZ, bi_VU, it_VA, es_VE, vi_VN, en_VI, fr_WF, ar_EH, ar_YE, en_ZM, en_ZW, fr_CI |
created_by | JSON | Optional | Represents the user who created this user record. Returns null if the creator information is not available. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details. |
created_by (anyOf 1) | object | Alternative | Represents the user who created this user record, identified by their unique ID and full name. Read only: true Additional keys: not allowed |
created_by (anyOf 1).id | string | Required within parent | Represents the unique ID of the user who created this record. Maximum length: 19 |
created_by (anyOf 1).name | string | Required within parent | Represents the full name of the user who created this record. Maximum length: 100 |
created_by (anyOf 2) | null | Alternative | Indicates that no creator information is available for this user record. |
created_time | JSON | Optional | Represents the date and time when this user record was first added to the system, in ISO 8601 format. Returns null if the creation time is not available. |
created_time (anyOf 1) | string | Alternative | Represents the date and time when this user record was first created. Format: date-time Read only: true |
created_time (anyOf 2) | null | Alternative | Indicates that no creation time is available for this user record. |
customize_info | object | Optional | Represents a collection of user interface customization preferences associated with the user's account. Additional keys: allowed |
customize_info.bc_view | JSON | Optional | Indicates whether the breadcrumb view is displayed for the user.\nPossible values:\ntrue - The breadcrumb view is displayed.\nfalse - The breadcrumb view is not displayed. |
customize_info.bc_view (anyOf 1) | boolean | Alternative | Indicates that the breadcrumb view is displayed for the user. |
customize_info.bc_view (anyOf 2) | null | Alternative | Indicates that the breadcrumb view is not displayed for the user. |
customize_info.notes_desc | JSON | Optional | |
customize_info.notes_desc (anyOf 1) | boolean | Alternative | Indicates whether notes are displayed in descending order for the user.\nPossible values:\ntrue - Notes are displayed in descending order.\nfalse - Notes are not displayed in descending order. |
customize_info.notes_desc (anyOf 2) | null | Alternative | Indicates whether notes are displayed in descending order for the user.\nPossible values:\ntrue - Notes are displayed in descending order.\nfalse - Notes are not displayed in descending order. |
customize_info.show_detail_view | boolean | Optional | Indicates whether the detail view panel is displayed for the user.\nPossible values:\ntrue - The detail view panel is displayed.\nfalse - The detail view panel is not displayed. |
customize_info.show_home | boolean | Optional | Indicates whether the home screen is displayed for the user.\nPossible values:\ntrue - The home screen is displayed.\nfalse - The home screen is not displayed. |
customize_info.show_left_panel | JSON | Optional | |
customize_info.show_left_panel (anyOf 1) | boolean | Alternative | Indicates whether the left panel is displayed in the user interface.\n\nPossible values:\ntrue - The left panel is shown.\nfalse - The left panel is hidden. |
customize_info.show_left_panel (anyOf 2) | null | Alternative | Indicates whether the left panel is displayed in the user interface.\n\nPossible values:\ntrue - The left panel is shown.\nfalse - The left panel is hidden. |
customize_info.show_right_panel | JSON | Optional | Indicates whether the right panel is displayed in the user interface.\n\nPossible values:\ntrue - The right panel is shown.\nfalse - The right panel is hidden. |
customize_info.show_right_panel (anyOf 1) | string | Alternative | Indicates that the right panel is displayed in the user interface. Maximum length: 20 |
customize_info.show_right_panel (anyOf 2) | null | Alternative | Indicates that the right panel is not displayed in the user interface. |
customize_info.unpin_recent_item | JSON | Optional | Indicates whether the recent item is unpinned from its fixed position in the user interface.\n\nPossible values:\ntrue - The recent item is unpinned.\nfalse - The recent item remains pinned. |
customize_info.unpin_recent_item (anyOf 1) | boolean | Alternative | Indicates that the recent item is unpinned from its fixed position. |
customize_info.unpin_recent_item (anyOf 2) | null | Alternative | Indicates that the recent item remains pinned in its fixed position. |
date_format | string | Optional | Represents the user's preferred date format used for displaying date values throughout the application. Known values: dd-MM-yyyy, dd/MM/yyyy, dd.MM.yyyy, dd MM yyyy, dd-MM-yy, dd/MM/yy, dd.MM.yy, d.MM.yy, d-M-yy, d/M/yy, d.M.yy, d.M.yy., d-M-yyyy, d/M/yyyy, d.M.yyyy, d. M. yyyy., d. M. yyyy, d MMM, yyyy, dd MMM, yyyy, d. MMMM yyyy, dd.MM.yyyy., dd.MM.yy., yyyy-MM-dd, yyyy/MM/dd, yyyy.MM.dd, yyyy MM dd, yy/MM/dd, yy-MM-dd, yy.M.d, yy-M-d, yy. M. d, yyyy/M/d, yyyy年MM月dd日, yy年M月d日, yyyy.MM.dd., yyyy. MM. dd, MM-dd-yyyy, MM/dd/yyyy, MM.dd.yyyy, MM dd yyyy, MM-dd-yy, MM/dd/yy, M/dd/yy, MMM-dd-yyyy, MMM dd, yyyy, MMM d, yyyy, MMMM d, yyyy, yyyy.dd.MM, yy.d.M |
decimal_separator | string | Optional | Represents the user's preferred decimal separator character used when displaying numerical values. Known values: Comma, Period |
default_tab_group | string | Optional | Represents the default tab group assigned to the user, determining which group of tabs is presented upon login. Maximum length: 100 |
distance_preference__s | string | Optional | Represents the user's preferred unit of measurement for displaying distance values. Known values: Kilometers, Miles |
dob | JSON | Optional | Represents the user's date of birth. Returns null if no date of birth has been set. |
dob (anyOf 1) | string | Alternative | Represents the user's date of birth. Format: date |
dob (anyOf 2) | null | Alternative | Indicates that no date of birth is set for the user. |
email | string | Optional | Represents the email address associated with the user's account. Maximum length: 100 |
ezuid | string | Optional | Represents the encrypted Zoho User ID (ZUID), used to securely identify the user without showing their actual ID. Maximum length: 100 Read only: true |
fax | JSON | Optional | Represents the user's fax number. Returns null if no fax number is configured. |
fax (anyOf 1) | string | Alternative | Represents the user's fax number. Maximum length: 30 |
fax (anyOf 2) | null | Alternative | Indicates that no fax number is configured for the user. |
first_name | JSON | Optional | Represents the user's first name. Returns null if no first name is set. |
first_name (anyOf 1) | string | Alternative | Represents the first name of the user. Maximum length: 50 |
first_name (anyOf 2) | null | Alternative | Indicates that no first name is set for the user. |
full_name | string | Optional | Represents the user's full name. Maximum length: 100 Read only: true |
id | string | Optional | Represents the unique identifier of the user. Maximum length: 19 Read only: true |
image_link | string | Optional | Represents the URL of the user's profile image as provided by the Identity and Access Management (IAM) system. Maximum length: 100 |
imap_status | boolean | Optional | Indicates whether IMAP access is enabled for the user.\nPossible values:\ntrue - IMAP access is enabled.\nfalse - IMAP access is disabled. |
language | string | Optional | Represents the preferred language of the user. This value can be updated only by the user themselves. Known values: af_NA, en_IN, af_ZA, ak_GH, su_ID, cy_GB, de_CH, de_AT, en_AU, en_CA, en_GB, en_IE, en_NZ, en_SG, en_US, en_ZA, ee_GH, ee_TG, fy_NL, ga_GB, ga_IE, gv_IM, ki_KE, gd_GB, ha_GH, ha_NG, ha_NE, ig_NG, rn_BI, jv_ID, rw_RW, sw_CD, sw_KE, sw_TZ, sw_UG, lg_UG, lb_LU, mg_MG, mt_MT, ms_BN, ms_ID, ms_MY, ms_SG, nl_BE, nl_BQ, om_ET, om_KE, ff_GN, ff_SN, qu_BO, qu_EC, qu_PE, so_ET, so_DJ, so_KE, so_SO, sg_CF, vi_VN, lu_CD, tr_CY, tr_TR, wo_SN, az_AZ, bm_ML, bs_BA, br_FR, ca_AD, ca_ES, ca_FR, ca_IT, sn_ZW, da_DK, da_GL, se_NO, se_SE, se_FI, et_EE, es_AR, es_BO, es_CL, es_CO, es_CR, es_EC, es_SV, es_GT, es_HN, es_NI, es_PA, es_PY, es_PE, es_PR, es_DO, es_UY, es_VE, eu_ES, fr_BE, fr_CA, fr_CH, fo_DK, fo_FO, gl_ES, hr_BA, hr_HR, nd_ZW, xh_ZA, zu_ZA, it_VA, it_IT, it_SM, it_CH, kl_GL, kw_GB, ku_TR, lv_LV, to_TO, lt_LT, ln_AO, ln_CG, ln_CF, ln_CD, hu_HU, nn_NO, no_NO, nb_NO, nb_SJ, uz_AF, uz_UZ, pl_PL, ro_MD, ro_RO, rm_CH, sq_XK, sq_MK, sq_AL, sk_SK, sl_SI, fi_FI, sv_FI, sv_SE, sv_AX, mi_NZ, tk_TM, yo_BJ, yo_NG, is_IS, cs_CZ, el_GR, el_CY, be_BY, bg_BG, os_GE, os_RU, ky_KG, mk_MK, mn_MN, ce_RU, sr_BA, sr_CS, sr_RS, sr_ME, tt_RU, tg_TJ, uk_UA, kk_KZ, hy_AM, ug_CN, ur_IN, ur_PK, ar_JO, ar_AE, ar_BH, ar_DZ, ar_SD, ar_IQ, ar_KW, ar_MA, ar_SA, ar_YE, ar_TN, ar_SY, ar_OM, ar_QA, ar_LB, ar_LY, sd_PK, sd_IN, fa_AF, fa_IR, ps_AF, ps_PK, ks_IN, ne_NP, ne_IN, mr_IN, sa_IN, hi_IN, as_IN, bn_BD, bn_IN, pa_PK, pa_IN, gu_IN, or_IN, ta_IN, ta_LK, ta_SG, ta_MY, te_IN, kn_IN, ml_IN, si_LK, th_TH, lo_LA, bo_IN, bo_CN, dz_BT, my_MM, ka_GE, ti_ET, ti_ER, am_ET, km_KH, zh_MO, zh_HK, zh_SG, zh_CN, zh_TW, ja_JP, ii_CN, ko_KR, ko_KP |
last_name | JSON | Optional | Represents the user's last name. Returns null if no last name is set. |
last_name (anyOf 1) | string | Alternative | Represents the last name of the user. Maximum length: 50 |
last_name (anyOf 2) | null | Alternative | Indicates that no last name is set for the user. |
locale | string | Optional | Represents the locale of the user. Known values: in_ID, en_IN, zh_CN, zh_TW, da_DK, de_DE, en_GB, en_US, es_ES, fr_FR, iw_IL, hr_HR, it_IT, hu_HU, nl_NL, pl_PL, pt_BR, pt_PT, sv_SE, vi_VN, tr_TR, cs_CZ, bg_BG, ru_RU, ar_EG, hi_IN, th_TH, ja_JP, ko_KR |
microsoft | boolean | Optional | Indicates whether the user is authenticated via a Microsoft account.\nPossible values:\ntrue - The user is a Microsoft account user.\nfalse - The user is not a Microsoft account user. |
mobile | JSON | Optional | |
mobile (anyOf 1) | string | Alternative | Represents the user's mobile phone number. Returns null when no mobile number is associated with the account. Maximum length: 30 |
mobile (anyOf 2) | null | Alternative | Represents the user's mobile phone number. Returns null when no mobile number is associated with the account. Maximum length: 30 |
name_format__s | string | Optional | Represents the format used to display the user's name. Known values: Salutation,First Name,Last Name, Salutation,Last Name,First Name, First Name,Salutation,Last Name, First Name,Last Name,Salutation, Last Name,Salutation,First Name, Last Name,First Name,Salutation |
ntc_enabled | boolean | Optional | Indicates whether Notification Template Configuration (NTC) is enabled for the user.\n\nPossible values:\ntrue - NTC is enabled and notification templates are applied to the user.\nfalse - NTC is disabled and notification templates are not applied to the user. |
ntc_notification_type | array | Optional | Represents the list of Notification Template Configuration (NTC) notification type identifiers assigned to the user. Maximum items: 100 |
ntc_notification_type[] | JSON | Each item | |
ntc_notification_type[] (anyOf 1) | integer | Alternative | Represents the unique identifier of a Notification Template Configuration (NTC) notification type. Format: int64 |
ntc_notification_type[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_separator | string | Optional | Represents the character used as a separator when formatting numbers for the user. This field is case-insensitive. Known values: Comma, Period, Space, comma, period, space |
offset | JSON | Optional | |
offset (anyOf 1) | integer | Alternative | Represents the user's current UTC offset in milliseconds, adjusted for Daylight Saving Time (DST) where applicable. For example, a timezone of UTC+5:30 yields an offset value of 19800000 (5.5 hours × 3600 seconds × 1000 milliseconds). This value may be added to the current UTC time to derive the user's local time. Format: int32 Read only: true |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
personal_account | boolean | Optional | Indicates whether the user has a personal account associated with their profile.\n\nPossible values:\ntrue - The user has a personal account.\nfalse - The user does not have a personal account. |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Represents the user's phone number. Returns null when no phone number is associated with the account. Maximum length: 30 |
phone (anyOf 2) | null | Alternative | Represents the user's phone number. Returns null when no phone number is associated with the account. Maximum length: 30 |
profile | object | Optional | Represents the profile associated with the user, including the profile's unique identifier and display name. Additional keys: not allowed |
profile.id | string | Required within parent | Represents the unique identifier of the profile associated with the user. Maximum length: 19 |
profile.name | string | Required within parent | Represents the display name of the profile associated with the user. Maximum length: 50 |
role | object | Optional | Represents the role assigned to the user, containing the role's unique identifier and display name. Additional keys: not allowed |
role.id | string | Required within parent | Represents the unique identifier of the role assigned to the user. Maximum length: 19 |
role.name | string | Required within parent | Represents the display name of the role assigned to the user. Maximum length: 200 |
rtl_enabled | boolean | Optional | Indicates whether Right-to-Left (RTL) text direction is enabled for the user's interface.\n\nPossible values:\ntrue - RTL text direction is enabled for the user.\nfalse - RTL text direction is not enabled for the user. |
sandboxDeveloper | boolean | Optional | Indicates whether the user is designated as a sandbox developer.\n\nPossible values:\ntrue - The user is a sandbox developer.\nfalse - The user is not a sandbox developer. |
share_among_subordinates | boolean | Optional | Indicates whether the user's records are shared with their subordinates.\n\nPossible values:\ntrue - Records are shared with subordinates.\nfalse - Records are not shared with subordinates. |
signature | JSON | Optional | |
signature (anyOf 1) | string | Alternative | Represents the email signature configured for the user. Returns null if no signature has been set. Maximum length: 200 |
signature (anyOf 2) | null | Alternative | Represents the email signature configured for the user. Returns null if no signature has been set. Maximum length: 200 |
sort_order_preference__s | string | Optional | Represents the user's preferred sort order for displaying records. Known values: First Name,Last Name, Last Name,First Name |
state | JSON | Optional | Represents the user's state or province. Returns null if no state is set. |
state (anyOf 1) | string | Alternative | Represents the state or province associated with the user. Maximum length: 100 |
state (anyOf 2) | null | Alternative | Indicates that no state or province is set for the user. |
status | JSON | Optional | Represents the current status of the user in the Zoho CRM organization. Possible values: active - The user is active and can access the CRM. inactive - The user is deactivated and cannot access the CRM. deleted - The user account has been deleted. disabled - The user account is disabled. closed - The user account is closed. disabled dormant - The user account is disabled and dormant. |
status (anyOf 1) | string | Alternative | Represents the current status of the user in the Zoho CRM organization. Known values: deleted, disabled, closed, disabled dormant Read only: true |
status (anyOf 2) | string | Alternative | Indicates that no status is set for the user. Known values: active, inactive |
status_reason__s | JSON | Optional | Represents the reason for the user's current status. Returns null if no reason is associated with the current status. |
status_reason__s (anyOf 1) | string | Alternative | Represents the reason for the user's current status. Known values: disabled due to license limit reached, waiting for approval, disabled due to license downgrade, disabled due to record is in recycle bin, disabled manually, disabled on updation of email |
status_reason__s (anyOf 2) | null | Alternative | Indicates that no status reason is associated with the user's current status. |
street | JSON | Optional | Represents the user's street address. Returns null if no street address is set. |
street (anyOf 1) | string | Alternative | Represents the street address associated with the user. Maximum length: 250 |
street (anyOf 2) | null | Alternative | Indicates that no street address is set for the user. |
telephony_enabled | boolean | Optional | Indicates whether telephony is enabled for the user.\nPossible values:\ntrue - Telephony is enabled for the user.\nfalse - Telephony is not enabled for the user. |
theme | object | Optional | Represents the theme configuration applied to the user's CRM interface. Includes color and display settings for the background, screen, header, normal tab, and selected tab elements. Read only: true Additional keys: not allowed |
theme.background | string | Optional | Represents the background color of the user's theme. Format: hex-color |
theme.header | Model | Optional | Expand Get a specific user — response body — users users item theme header |
theme.new_background | JSON | Optional | |
theme.new_background (anyOf 1) | string | Alternative | Represents the updated background color applied to the user's theme. Format: hex-color |
theme.new_background (anyOf 2) | null | Alternative | Represents the updated background color applied to the user's theme. Format: hex-color |
theme.normal_tab | Model | Optional | Expand Get a specific user — response body — users users item theme normal tab |
theme.screen | string | Optional | Represents the screen type or layout setting applied to the user's CRM interface. Known values: fixed |
theme.selected_tab | Model | Optional | Expand Get a specific user — response body — users users item theme selected tab |
theme.type | string | Optional | Represents the type of theme applied to the user's CRM interface. Known values: default, custom |
time_format | string | Optional | Represents the time format preferred by the user for displaying time values. Known values: HH:mm, hh:mm a |
time_zone | string | Optional | Represents the time zone of the user. This value can be updated only by the user themselves. Maximum length: 150 |
type__s | string | Optional | Represents the account type of the user. Known values: Sandbox Developer User, Support User, Client Portal User, Regular User, Team User, System User, Digital Employee Read only: true |
website | JSON | Optional | Represents the user's website URL. Returns null if no website is configured. |
website (anyOf 1) | string | Alternative | Represents the website URL associated with the user. Maximum length: 250 |
website (anyOf 2) | null | Alternative | Indicates that no website URL is configured for the user. |
zip | JSON | Optional | Represents the user's postal code or ZIP code. Returns null if no postal code is set. |
zip (anyOf 1) | string | Alternative | Represents the postal code or ZIP code associated with the user. Maximum length: 30 |
zip (anyOf 2) | null | Alternative | Indicates that no postal code is set for the user. |
zuid | JSON | Optional | Represents the Zoho User ID (ZUID) associated with the user's Zoho account. Read only: true |
zuid (anyOf 1) | string | Alternative | Represents the Zoho User ID (ZUID) associated with the user. Maximum length: 19 |
zuid (anyOf 2) | null | Alternative | Indicates that no ZUID is associated with the user. |
Referenced models: Get a specific user — response body — users users item theme header, Get a specific user — response body — users users item theme normal tab, Get a specific user — response body — users users item theme selected tab
Get a specific user — response body — users users item theme header
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the theme configuration for the header area of the user's CRM interface. Includes the background color and font color settings for the header. Additional keys: not allowed |
background | string | Optional | Represents the background color of the header area in the user's theme. Format: hex-color |
font_color | string | Optional | Represents the font color of the header area in the user's theme. Format: hex-color |
Get a specific user — response body — users users item theme normal tab
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the theme configuration for the normal (unselected) tab in the user's CRM interface, including background color and font color settings. Additional keys: not allowed |
background | string | Optional | Represents the background color of the normal tab in the user's theme. Format: hex-color |
font_color | string | Optional | Represents the font color of the normal tab in the user's theme. Format: hex-color |
Get a specific user — response body — users users item theme selected tab
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the theme configuration for the currently selected tab in the user's CRM interface, including background color and font color settings. Additional keys: not allowed |
background | string | Optional | Represents the background color of the selected tab in the user's theme. Format: hex-color |
font_color | string | Optional | Represents the font color of the selected tab in the user's theme. Format: hex-color |
Get users — response body — info, users info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination metadata returned with the user list response, including the current page, records per page, total count, and whether additional pages are available. Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the total number of user records returned in the current response. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Indicates whether additional records are available beyond the current page.\n\nPossible values:\ntrue - More records are available on subsequent pages.\nfalse - No more records are available. |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated response. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Required within parent | |
per_page (anyOf 1) | integer | Alternative | Represents the number of user records returned per page. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |