Zendesk · Schema
User
A Zendesk user representing an end user, agent, or admin in the account.
ChatCRMHelp CenterSellSupportT1TalkTicketingTickets
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | Automatically assigned user ID. |
| url | string | The API URL of the user. |
| name | string | The name of the user. |
| string | The primary email address of the user. | |
| phone | string | The primary phone number of the user. |
| photo | object | The user's profile photo. |
| locale_id | integer | The locale ID of the user. |
| locale | string | The locale of the user (e.g., en-US). |
| time_zone | string | The time zone of the user. |
| organization_id | integer | The ID of the user's default organization. |
| role | string | The role of the user. |
| custom_role_id | integer | The custom role ID for agents with custom roles. |
| verified | boolean | Whether the user's identity has been verified. |
| external_id | string | An external ID for the user from an integrated system. |
| tags | array | Tags applied to the user. |
| alias | string | An alias displayed instead of the agent's name. |
| active | boolean | Whether the user account is active. |
| shared | boolean | Whether the user is shared from a different Zendesk Support instance. |
| shared_agent | boolean | Whether the user is a shared agent from a different instance. |
| shared_phone_number | boolean | Whether the phone number is shared. |
| signature | string | The signature text appended to the agent's comments. |
| details | string | Details about the user visible only to agents. |
| notes | string | Notes about the user visible only to agents. |
| restricted_agent | boolean | Whether the agent has restrictions (true for agents in a custom role with restrictions). |
| suspended | boolean | Whether the user is suspended. |
| default_group_id | integer | The default group ID for the agent. |
| report_csv | boolean | Whether the user can access the CSV report. |
| only_private_comments | boolean | Whether the user can only create private comments (for restricted end users). |
| ticket_restriction | string | The ticket access restriction for the agent. |
| moderator | boolean | Whether the user has community moderator privileges. |
| chat_only | boolean | Whether the user is a chat-only agent. |
| two_factor_auth_enabled | boolean | Whether two-factor authentication is enabled. |
| user_fields | object | Custom user field values (key-value pairs). |
| last_login_at | string | The last time the user signed in (ISO 8601). |
| created_at | string | When the user was created (ISO 8601). |
| updated_at | string | When the user was last updated (ISO 8601). |