Read User

Read searched user.



Deleted users can still be read, but their account are no longer active and can't be reactivated.


Field Definition Type Required
Read By
User ID Unique identification number of the user that will be read. The ID can be found in the URL of the document in this format : http://< your domain>< User ID >. Number TRUE


Field Definition Type
User ID Unique ID of the user created. Number
User URL A URL to the user. String
Name Name of user. String
Email The user's primary email address. String
Created At Time and date the user was created. Date & Time
Updated At Time and date the user was updated. Date & Time
Timezone The user's time zone. See Time Zone.. String
IANA Timezone The IANA time zone of the user. String
Phone The user's phone number. String
Shared Phone Number If true, the phone number is shared. Boolean
Locale ID The user's language identifier. Number
Locale The user's locale. This is a BCP-47 compliant tag. String
Organization ID Identification code of organization user is associated with. Number
Role The user's role. Possible values are end-user, agent, or admin. String
Verified? If true, user is verified. Boolean
External ID The user's unique external ID. String
Tags The user's tags. Only present is your account has user tagging available. List
Alias The user's alias. String
Active? If false, user was deleted. Boolean
Shared? If true, user is shared. Boolean
Shared Agent? If true, user is a shared agent from another support instance. Boolean
Last Login At The last time the user signed in. Date & Time
Two Factor Auth Enabled If true, two factor authentication is enabled. Boolean
Signature The user's signature. Only agents and admins have a signature. String
Details Any details you want to store about the user, such as an address. String
Notes Any notes you want to store about the user. String
Role Type The user's role type. Number
Custom Role ID The user's custom role. String
Moderator? If true, the user has forum moderation capabilities. Boolean
Ticket Restriction Specifies which tickets the user has access to. String
Private Comments Only? If true, the user can only create private comments. Boolean
Restricted Agent? If true, the agent has restrictions. Boolean
Suspended? If true, the agent is suspended. Boolean
Chat Only? If true, the user is a chat-only agent. Boolean
Default Group ID The user's default group ID. Number
Report CSV? If true, the user can access the CSV report. Boolean
Custom Fields A dynamically generated list of any custom fields associated with users. More on custom Fields. Various

Related topics

Zendesk connector

About the elements of Okta Workflows

Zendesk REST API Documentation