AllCustomers
Returns customer user records, including profile, role, and account preference details.
Columns
| Name | Type | References | Description |
| Id [KEY] | Long | The Id automatically assigned when the user is created. | |
| String | The primary email address of the user. Writeable on create only. On update, a secondary email is added. | ||
| Name | String | The name of the user. | |
| Role | String | The role of the user. Possible values are end-user, agent, or admin. | |
| Active | Boolean | Indicates whether the user is active. This value is false if the user has been deleted. | |
| OrganizationId | Long | The Id of the organization the user is associated with. | |
| Alias | String | An alias displayed to end users. | |
| Verified | Boolean | Indicates whether the identity of the user has been verified. | |
| ChatOnly | Boolean | Indicates whether the user is a chat-only agent. | |
| CreatedAt | Datetime | The date and time when the user was created. | |
| UpdatedAt | Datetime | The date and time when the user was last updated. | |
| CustomRoleId | Long | A custom role if the user is an agent on the Enterprise plan. | |
| RoleType | String | The role Id of the user. 0 for custom agents, 1 for light agent, and 2 for chat agent. | |
| DefaultGroupId | Long | The Id of the default group of the user. Can only be set on create, not on update. | |
| Details | String | Any additional details stored about the user, such as an address. | |
| ExternalId | String | A unique identifier from another system. | |
| LastLoginAt | Datetime | The last time the user signed in to Zendesk Support. | |
| Locale | String | The locale of the user. | |
| LocaleId | Long | The language identifier of the user. | |
| Moderator | Boolean | Designates whether the user has forum moderation capabilities. | |
| Notes | String | Any additional notes stored about the user. | |
| OnlyPrivateComments | Boolean | Indicates whether the user can only create private comments. | |
| Phone | String | The primary phone number of the user. | |
| Photo | String | The photo attachment. | |
| PhotoThumbnails | String | The photo thumbnails. | |
| PhotoInline | Boolean | Indicates whether the attachment is excluded from the attachment list and its URL can be referenced within a ticket comment. Default is false. | |
| RestrictedAgent | Boolean | Indicates whether the agent has any restrictions. This value is false for admins and unrestricted agents, and true for other agents. | |
| Shared | Boolean | Indicates whether the user is shared from a different Zendesk Support instance. Applies to ticket sharing accounts only. | |
| SharedAgent | Boolean | Indicates whether the user is a shared agent from a different Zendesk Support instance. Applies to ticket sharing accounts only. | |
| Signature | String | The signature of the user. Only agents and admins can have signatures. | |
| Suspended | Boolean | Indicates whether the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end-user portal. | |
| Tags | String | The tags of the user. Only present if your account has user tagging enabled. | |
| TicketRestriction | String | Specifies which tickets the user has access to. Possible values are: organization, groups, assigned, requested, null. | |
| TimeZone | String | The time zone of the user. | |
| TwoFactorAuthEnabled | Boolean | Indicates whether two-factor authentication is enabled for the user. | |
| Url | String | The API URL of the user. | |
| PermissionSet | String | The permission set used for custom roles in the Enterprise plan. Only one role Id can be used to filter per request. |