> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Users Get Single User

> Get one Zoho CRM user by ID, with their email, role, profile and status. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one Zoho CRM user by ID, with their email, role, profile and status.

> [!NOTE]
>
> Tool ID: `zoho_crm_users_get_single_user`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_users_get_single_user',
  {
    "user": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_users_get_single_user --input '{
  "user": "example"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe zoho_crm_users_get_single_user --json` for the complete live contract.

## Input reference

To get a single user based on the provided user ID.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.user` | `string` | Yes | — | user Id Maximum length: 20. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To get a single user based on the provided user ID.",
    "properties": {
      "user": {
        "type": "string",
        "description": "user Id",
        "maxLength": 20
      }
    },
    "required": [
      "user"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | List of users found based on the provided parameters. |
| `result.data.users` | `array` | No | — | List of users Maximum items: 200. |
| `result.data.users[].$current_shift` | `record` | No | — | Current shift assigned to the user |
| `result.data.users[].$next_shift` | `record` | No | — | Next shift assigned to the user |
| `result.data.users[].Current_Shift__s` | `record` | No | — | To update current shift for the user |
| `result.data.users[].$shift_effective_from` | `record` | No | — | Next shift effective from date |
| `result.data.users[].confirm` | `boolean` | No | — | Indicates whether the user has accepted the invitation |
| `result.data.users[].date_format` | `"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"` | No | — | User's preferred date format Allowed: `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. See the live schema for the complete constraint. |
| `result.data.users[].decimal_separator` | `"Comma" \| "Period"` | No | — | User's preferred decimal separator Allowed: `Comma`, `Period`. |
| `result.data.users[].email` | `string` | No | — | User's email address Maximum length: 100. Pattern: `^[\+\-\p&#123;L&#125;\p&#123;M&#125;\p&#123;N&#125;_]([\p&#123;L&#125;\p&#123;M&#125;\p&#123;N&#125;!#$%&'*+\-\/=?^_`\{\|}\~.]\*)@(?=.\{4,256}$)(([\p&#123;L&#125;\p&#123;N&#125;\p&#123;M&#125;]+)(([\-_]*[\p&#123;L&#125;\p&#123;M&#125;\p&#123;N&#125;])*)[.])+[\p&#123;L&#125;\p&#123;M&#125;]&#123;2,22&#125;$\`. |
| `result.data.users[].first_name` | `string` | No | — | User's first name Maximum length: 50. |
| `result.data.users[].full_name` | `string` | No | — | User's full name Maximum length: 100. |
| `result.data.users[].id` | `string` | No | — | User's id Maximum length: 20. |
| `result.data.users[].last_name` | `record` | No | — | — |
| `result.data.users[].type__s` | `"Sandbox Developer User" \| "Support User" \| "Client Portal User" \| "Regular User" \| "Lite User" \| "System User"` | No | — | Type of user Allowed: `Sandbox Developer User`, `Support User`, `Client Portal User`, `Regular User`, `Lite User`, `System User`. |
| `result.data.users[].profile` | `object` | No | — | Profile details |
| `result.data.users[].profile.name` | `string` | Yes | — | Name of the profile Maximum length: 50. |
| `result.data.users[].profile.id` | `string` | Yes | — | ID of the profile Maximum length: 20. |
| `result.data.users[].role` | `object` | No | — | Role details |
| `result.data.users[].role.name` | `string` | Yes | — | Name of the role Maximum length: 200. |
| `result.data.users[].role.id` | `string` | Yes | — | ID of the role Maximum length: 20. |
| `result.data.users[].status` | `record` | No | — | — |
| `result.data.users[].zuid` | `record` | No | — | User's ZUID |
| `result.data.users[].alias` | `record` | No | — | — |
| `result.data.users[].created_by` | `record` | No | — | — |
| `result.data.users[].created_time` | `record` | No | — | — |
| `result.data.users[].locale` | `"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"` | No | — | User's locale. Allowed: `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`. |
| `result.data.users[].microsoft` | `boolean` | No | — | Indicates whether the user is a Microsoft user |
| `result.data.users[].Modified_By` | `record` | No | — | — |
| `result.data.users[].Modified_Time` | `record` | No | — | — |
| `result.data.users[].phone` | `string \| null` | No | — | User's phone number Maximum length: 30. |
| `result.data.users[].mobile` | `string \| null` | No | — | User's mobile Maximum length: 30. |
| `result.data.users[].city` | `record` | No | — | — |
| `result.data.users[].country` | `record` | No | — | — |
| `result.data.users[].dob` | `record` | No | — | — |
| `result.data.users[].fax` | `record` | No | — | — |
| `result.data.users[].number_separator` | `"Comma" \| "Period" \| "Space" \| "comma" \| "period" \| "space"` | No | — | number seperator-(no case sensitive) Allowed: `Comma`, `Period`, `Space`, `comma`, `period`, `space`. |
| `result.data.users[].state` | `record` | No | — | — |
| `result.data.users[].street` | `record` | No | — | — |
| `result.data.users[].time_format` | `"HH:mm" \| "hh:mm a"` | No | — | Time format Allowed: `HH:mm`, `hh:mm a`. |
| `result.data.users[].website` | `record` | No | — | — |
| `result.data.users[].zip` | `record` | No | — | — |
| `result.data.users[].sandboxDeveloper` | `boolean` | No | — | Indicates whether the user is a sandbox developer |
| `result.data.users[].name_format__s` | `"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"` | No | — | name format Allowed: `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`. |
| `result.data.users[].language` | `"af_NA" \| "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"` | No | — | User's language. Can be updated only by the same user Allowed: `af_NA`, `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`, See the live schema for the complete constraint. |
| `result.data.users[].status_reason__s` | `record` | No | — | — |
| `result.data.users[].country_locale` | `"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"` | No | — | User's country locale Allowed: `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`, See the live schema for the complete constraint. |
| `result.data.users[].ezuid` | `string` | No | — | encrypted zuid Maximum length: 100. |
| `result.data.users[].image_link` | `string` | No | — | IAM image URL Maximum length: 100. |
| `result.data.users[].sort_order_preference__s` | `"First Name,Last Name" \| "Last Name,First Name"` | No | — | sort order preference Allowed: `First Name,Last Name`, `Last Name,First Name`. |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe zoho_crm_users_get_single_user --json`.

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.