Get users

GET/users

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get users action (under Users).
Fill in the fields below, then reference the result from later steps as {{getUsers.response.data}}.

Request

Query parameters

typestring

Specify the type of users to retrieve. Possible values: CurrentUser - Retrieves the currently authenticated user. DeletedUsers - Retrieves only deleted users. DeactiveUsers - Retrieves only deactivated users. NotConfirmedUsers - Retrieves only unconfirmed users. ConfirmedUsers - Retrieves only confirmed users. ActiveUsers - Retrieves only active users. AdminUsers - Retrieves only administrator users. ActiveConfirmedAdmins - Retrieves active, confirmed, and administrator users. ActiveConfirmedUsers - Retrieves active and confirmed users. DeveloperUsers - Retrieves only developer users. AllUsers - Retrieves all users. AllActiveUsers - Retrieves all active users. ActiveLiteUser - Retrieves active lite users. ActiveAndDeactive - Retrieves both active and deactivated users. ChildRoleUsers - Retrieves users belonging to child roles. ParentRoleUsers - Retrieves users belonging to the parent role. SubordinateRoleUsers - Retrieves users in subordinate roles. ConfirmedReportingUsers - Retrieves confirmed users who have reporting relationships.

One ofCurrentUserDeletedUsersDeactiveUsersNotConfirmedUsersConfirmedUsersActiveUsersAdminUsersActiveConfirmedAdminsActiveConfirmedUsersDeveloperUsersAllUsersAllActiveUsersActiveLiteUserActiveAndDeactiveChildRoleUsersParentRoleUsersSubordinateRoleUsersConfirmedReportingUsers

pageinteger (int32)

Specify the page number to retrieve in the paginated response.

per_pageinteger (int32)

Specify the number of user records to return per page.

include_lite_usersboolean

Specify whether to include lite users in the result set.\n\nPossible values:\ntrue - Lite users are included.\nfalse - Lite users are not included.

role_idstring

Specify the role ID to filter users. The API retrieves users with the specified role and higher or lower roles based on the value of the **type** parameter. Applicable only for **ParentRoleUsers**, **ChildRoleUsers**, and **SubordinateRoleUsers** types.

query_idstring (int64)

Specify the query ID of the user lookup field. Used to retrieve users based on the filter criteria of the lookup field.

child_dataobject

Specify the child data object containing the record ID of the module with a user lookup field. This is required only if the user lookup field has criteria based on the dynamic value of a record. The **query_id** parameter is required when this parameter is provided.

idstring (int64)required

Record ID of the module with user look up field

idsarray<string>

Specify a comma-separated list of user IDs to retrieve. If not provided, the API retrieves all users based on the other parameters.

fieldsstring

Specify the comma-separated list of field API names to include in the response.

type__sstring

Filter users by their account type. Possible values: **Regular User** - Standard CRM user with full access to the organization. **Sandbox Developer User** - User with access to the sandbox environment for development and testing. **Team User** - User operating as part of a team account. **Digital Employee** - Automated or bot-type user representing a digital workforce entity. **Support User** - User with access granted for support purposes. **Client Portal User** - User with limited access via the client-facing portal.

One ofRegular UserSandbox Developer UserTeam UserDigital EmployeeSupport UserClient Portal User

Response

Returns 200 with an object. Read it in later steps with {{getUsers.response.data.<field>}}.

usersarray<object>

List of user objects, each representing an individual Zoho CRM user returned by the query.

$next_shiftoneOf

Represents the upcoming shift scheduled for the user, including the shift's ID and name.

$current_shiftoneOf

Represents the shift currently assigned to the user, including the shift's ID and name.

$shift_effective_fromoneOf

Represents the date on which the user's upcoming shift becomes effective.

confirmboolean

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.

date_formatstring

Represents the user's preferred date format used for displaying date values throughout the application.

One ofdd-MM-yyyydd/MM/yyyydd.MM.yyyydd MM yyyydd-MM-yydd/MM/yydd.MM.yyd.MM.yyd-M-yyd/M/yyd.M.yyd.M.yy.d-M-yyyyd/M/yyyyd.M.yyyyd. M. yyyy.d. M. yyyyd MMM, yyyydd MMM, yyyyd. MMMM yyyydd.MM.yyyy.dd.MM.yy.yyyy-MM-ddyyyy/MM/ddyyyy.MM.ddyyyy MM ddyy/MM/ddyy-MM-ddyy.M.dyy-M-dyy. M. dyyyy/M/dyyyy年MM月dd日yy年M月d日yyyy.MM.dd.yyyy. MM. ddMM-dd-yyyyMM/dd/yyyyMM.dd.yyyyMM dd yyyy

decimal_separatorstring

Represents the user's preferred decimal separator character used when displaying numerical values.

One ofCommaPeriod

emailstring

Represents the email address associated with the user's account.

first_nameoneOf

Represents the user's first name. Returns null if no first name is set.

full_namestring

Represents the user's full name.

idstring

Represents the unique identifier of the user.

last_nameoneOf

Represents the user's last name. Returns null if no last name is set.

type__sstring

Represents the account type of the user.

One ofSandbox Developer UserSupport UserClient Portal UserRegular UserTeam UserSystem UserDigital Employee

profileobject2 fields

Represents the profile associated with the user, including the profile's unique identifier and display name.

roleobject2 fields

Represents the role assigned to the user, containing the role's unique identifier and display name.

statusoneOf

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.

zuidoneOf

Represents the Zoho User ID (ZUID) associated with the user's Zoho account.

aliasoneOf

Represents the alias or short name associated with the user. Returns null if no alias is configured.

created_byoneOf

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_timeoneOf

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.

localestring

Represents the locale of the user.

One ofin_IDen_INzh_CNzh_TWda_DKde_DEen_GBen_USes_ESfr_FRiw_ILhr_HRit_IThu_HUnl_NLpl_PLpt_BRpt_PTsv_SEvi_VNtr_TRcs_CZbg_BGru_RUar_EGhi_INth_THja_JPko_KR

microsoftboolean

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.

Modified_ByoneOf

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_TimeoneOf

Represents the date and time at which this user record was last modified, in ISO 8601 format. Returns null if no modification has occurred.

phonestring | null

Represents the user's phone number. Returns null when no phone number is associated with the account.

mobilestring | null

Represents the user's mobile phone number. Returns null when no mobile number is associated with the account.

cityoneOf

Represents the city associated with the user's address. Returns null if no city is configured.

countryoneOf

Represents the country associated with the user's address. Returns null if no country is configured.

doboneOf

Represents the user's date of birth. Returns null if no date of birth has been set.

faxoneOf

Represents the user's fax number. Returns null if no fax number is configured.

number_separatorstring

Represents the character used as a separator when formatting numbers for the user. This field is case-insensitive.

One ofCommaPeriodSpacecommaperiodspace

stateoneOf

Represents the user's state or province. Returns null if no state is set.

streetoneOf

Represents the user's street address. Returns null if no street address is set.

time_formatstring

Represents the time format preferred by the user for displaying time values.

One ofHH:mmhh:mm a

websiteoneOf

Represents the user's website URL. Returns null if no website is configured.

ziponeOf

Represents the user's postal code or ZIP code. Returns null if no postal code is set.

sandboxDeveloperboolean

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.

name_format__sstring

Represents the format used to display the user's name.

One ofSalutation,First Name,Last NameSalutation,Last Name,First NameFirst Name,Salutation,Last NameFirst Name,Last Name,SalutationLast Name,Salutation,First NameLast Name,First Name,Salutation

languagestring

Represents the preferred language of the user. This value can be updated only by the user themselves.

One ofaf_NAen_INaf_ZAak_GHsu_IDcy_GBde_CHde_ATen_AUen_CAen_GBen_IEen_NZen_SGen_USen_ZAee_GHee_TGfy_NLga_GBga_IEgv_IMki_KEgd_GBha_GHha_NGha_NEig_NGrn_BIjv_IDrw_RWsw_CDsw_KEsw_TZsw_UGlg_UGlb_LUmg_MGmt_MTms_BN

status_reason__soneOf

Represents the reason for the user's current status. Returns null if no reason is associated with the current status.

country_localestring

Represents the locale associated with the user's country.

One ofps_AFsv_AXsq_ALar_DZen_ASca_ADpt_AOen_AIen_AQen_AGes_ARhy_AMnl_AWen_AUde_ATaz_AZen_BSar_BHbn_BDen_BBbe_BYnl_BEfr_BEen_BZfr_BJen_BMen_BTes_BObs_BAen_BWno_BVpt_BRen_IOen_VGms_BNbg_BGfr_BFfr_BIkm_KHfr_CM

infoobject

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.

per_pageinteger (int32)required

Represents the number of user records returned per page.

countinteger (int32)required

Represents the total number of user records returned in the current response.

pageinteger (int32)required

Represents the current page number in the paginated response.

more_recordsbooleanrequired

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.

json

{
  "users": [
    {
      "$next_shift": null,
      "$current_shift": null,
      "$shift_effective_from": null,
      "confirm": false,
      "date_format": "dd-MM-yyyy",
      "decimal_separator": "Comma",
      "email": "string",
      "first_name": null,
      "full_name": "string",
      "id": "string",
      "last_name": null,
      "type__s": "Sandbox Developer User"
    }
  ],
  "info": {
    "per_page": 0,
    "count": 0,
    "page": 0,
    "more_records": false
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?