EndPoint Read Users (All)
Name
get_users
Description
Get a list of all users in your account
[API Help]
Parameters
| Parameter |
Label |
Required |
Options |
Description |
| role |
Role |
NO |
| Option |
Value |
| agent |
agent |
| admin |
admin |
| end-user |
end-user |
|
|
| permission_set |
permission_set |
NO |
|
|
| external_id |
External ID for Ticket |
NO |
|
|
Output Columns
| Label |
DataType |
Length |
Raw |
Description |
| id |
DT_I8 |
0 |
False |
|
| name |
DT_WSTR |
255 |
False |
|
| email |
DT_WSTR |
500 |
False |
|
| active |
DT_BOOL |
0 |
False |
|
| role |
DT_WSTR |
32 |
False |
|
| created_at |
DT_DBTIMESTAMP |
0 |
False |
|
| updated_at |
DT_DBTIMESTAMP |
0 |
False |
|
| time_zone |
DT_WSTR |
100 |
False |
|
| iana_time_zone |
DT_WSTR |
100 |
False |
|
| phone |
DT_WSTR |
100 |
False |
|
| url |
DT_WSTR |
500 |
False |
|
| shared_phone_number |
DT_BOOL |
0 |
False |
|
| locale_id |
DT_I8 |
0 |
False |
|
| locale |
DT_WSTR |
20 |
False |
|
| organization_id |
DT_I8 |
0 |
False |
|
| role_type |
DT_I8 |
0 |
False |
|
| verified |
DT_BOOL |
0 |
False |
|
| external_id |
DT_WSTR |
500 |
False |
|
| tags |
DT_WSTR |
1000 |
False |
|
| tags_1 |
DT_WSTR |
50 |
False |
|
| tags_2 |
DT_WSTR |
50 |
False |
|
| tags_3 |
DT_WSTR |
50 |
False |
|
| tags_4 |
DT_WSTR |
50 |
False |
|
| tags_5 |
DT_WSTR |
50 |
False |
|
| alias |
DT_WSTR |
255 |
False |
|
| shared |
DT_BOOL |
0 |
False |
|
| shared_agent |
DT_BOOL |
0 |
False |
|
| last_login_at |
DT_DBTIMESTAMP |
0 |
False |
|
| two_factor_auth_enabled |
DT_BOOL |
0 |
False |
|
| signature |
DT_WSTR |
80 |
False |
|
| details |
DT_WSTR |
4000 |
False |
|
| notes |
DT_WSTR |
4000 |
False |
|
| custom_role_id |
DT_I8 |
0 |
False |
|
| moderator |
DT_BOOL |
0 |
False |
|
| ticket_restriction |
DT_WSTR |
80 |
False |
|
| only_private_comments |
DT_BOOL |
0 |
False |
|
| restricted_agent |
DT_BOOL |
0 |
False |
|
| suspended |
DT_BOOL |
0 |
False |
|
| default_group_id |
DT_I8 |
0 |
False |
|
| report_csv |
DT_BOOL |
0 |
False |
|
| photo_url |
DT_WSTR |
500 |
False |
|
| photo_id |
DT_I8 |
0 |
False |
|
| photo_file_name |
DT_WSTR |
148 |
False |
|
| photo_content_url |
DT_WSTR |
500 |
False |
|
| photo_mapped_content_url |
DT_WSTR |
500 |
False |
|
| photo_content_type |
DT_WSTR |
40 |
False |
|
| photo_size |
DT_I8 |
0 |
False |
|
| photo_width |
DT_I8 |
0 |
False |
|
| photo_height |
DT_I8 |
0 |
False |
|
| photo_inline |
DT_BOOL |
0 |
False |
|
| photo_deleted |
DT_BOOL |
0 |
False |
|
| photo_thumbnails |
DT_WSTR |
4000 |
False |
|
| user_field_dt_[$parent.key$] |
DT_WSTR |
4000 |
False |
|
| user_field_[$parent.key$] |
DT_WSTR |
4000 |
False |
|
Input Columns
| Label |
DataType |
Length |
Raw |
Description |
| id |
DT_I8 |
0 |
False |
|
| name |
DT_WSTR |
120 |
False |
|
| email |
DT_WSTR |
160 |
False |
|
| alias |
DT_WSTR |
255 |
False |
|
| time_zone |
DT_WSTR |
104 |
False |
|
| phone |
DT_WSTR |
80 |
False |
|
| shared_phone_number |
DT_BOOL |
0 |
False |
|
| photo_id |
DT_WSTR |
1020 |
False |
|
| locale_id |
DT_I8 |
0 |
False |
|
| locale |
DT_WSTR |
20 |
False |
|
| organization_id |
DT_I8 |
0 |
False |
|
| organization_name |
DT_WSTR |
200 |
False |
|
| role |
DT_WSTR |
100 |
False |
|
| verified |
DT_BOOL |
0 |
False |
|
| external_id |
DT_WSTR |
500 |
False |
|
| tags |
DT_WSTR |
4000 |
True |
|
| signature |
DT_WSTR |
4000 |
False |
|
| details |
DT_WSTR |
4000 |
False |
|
| notes |
DT_WSTR |
4000 |
False |
|
| remote_photo_url |
DT_WSTR |
4000 |
False |
|
| custom_role_id |
DT_I8 |
0 |
False |
|
| moderator |
DT_BOOL |
0 |
False |
|
| ticket_restriction |
DT_WSTR |
80 |
False |
|
| only_private_comments |
DT_BOOL |
0 |
False |
|
| restricted_agent |
DT_BOOL |
0 |
False |
|
| suspended |
DT_BOOL |
0 |
False |
|
| default_group_id |
DT_I8 |
0 |
False |
|
| photo |
DT_WSTR |
4000 |
True |
|
| user_fields |
DT_WSTR |
4000 |
True |
|
| identities |
DT_WSTR |
4000 |
True |
|
