zendesk-users
Retrieve Zendesk user list.
zendesk-users profile=PROFILE
- profile=PROFILE
- Required. Profile name of Zendesk
Output Fields
| Field | Type | Name | Description |
|---|---|---|---|
| profile | String | Connect profile | Profile name of Zendesk |
| id | Long | ID | Automatically assigned when the user is created |
| org_name | String | Organization | Organization name that the user belongs to |
| name | String | Name | The user's full name |
| String | The user's primary email address | ||
| phone | String | Phone | Phone number in E.164 international format (e.g., +15551234567) |
| locale | String | Locale | User's language using BCP-47 compliant tag format (e.g., en-US, ko-KR) |
| time_zone | String | Time zone | User's time zone (e.g., Eastern Time (US & Canada), Seoul) |
| last_login_at | Date | Last login | Last time the user signed in to Zendesk Support or made an API request using an API token |
| tags | String | Tags | User's tags (requires user tagging to be enabled) |
| role | String | Role | User role (e.g., end-user, agent, admin) |
| role_type | Integer | Role type | User role type ID (0: custom agent, 1: light agent, 2: chat agent, 3: chat contributor, 4: admin, 5: billing admin) |
| role_type_name | String | Role type name | User role type name (e.g., custom agent, light agent, admin, billing admin) |
| is_active | Bool | Active | False if the user has been deleted |
| is_suspended | Bool | Suspended | When true, user cannot sign into Help Center and tickets are suspended |
| is_verified | Bool | Verified | True if any of the user's identities is verified |
| is_mfa_enabled | Bool | MFA enabled | Indicates if multi-factor authentication is active |
| is_restricted_agent | Bool | Restricted | True for agents with restrictions; false for admins and unrestricted agents |
| is_chat_only | Bool | Chat only | Whether the user is a chat-only agent |
| is_moderator | Bool | Moderator | Designates forum moderation capabilities |
| is_only_private_comments | Bool | Private comments only | True if user can only create private comments |
| ticket_restriction | String | Ticket restriction | Ticket access scope (e.g., organization, groups, assigned, requested, or null) |
| organization_id | Long | Organization ID | ID of user's organization or default organization if multiple memberships exist |
| custom_role_id | Long | Custom role ID | A custom role for agents on Enterprise plan or above |
| default_group_id | Long | Default group ID | ID of user's default group |
| locale_id | Long | Locale ID | User's language identifier |
| external_id | String | External ID | A unique identifier from another system (case-insensitive) |
| alias | String | Alias | A display name shown to end users |
| details | String | Details | Additional information about the user (e.g., addresses) |
| notes | String | Notes | Internal notes about the user |
| signature | String | Signature | User's signature (only agents and admins can have signatures) |
| created | Date | Created | User creation timestamp |
| updated | Date | Updated | Last update timestamp |