EndPoint Read User(s) by ID

Name

get_users_by_ids

Description

Get a list of users in your account for specific id(s) [API reference]

Parameters

Parameter	Label	Required	Options	Description
user_ids	User ID(S) - Use Comma for multiple (e.g. 111,222)	YES

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
id	`DT_I8`	`bigint`		`False`
name	`DT_WSTR`	`nvarchar(255)`	255	`False`
email	`DT_WSTR`	`nvarchar(500)`	500	`False`
active	`DT_BOOL`	`bit`		`False`
role	`DT_WSTR`	`nvarchar(32)`	32	`False`
created_at	`DT_DBTIMESTAMP`	`datetime`		`False`
updated_at	`DT_DBTIMESTAMP`	`datetime`		`False`
time_zone	`DT_WSTR`	`nvarchar(100)`	100	`False`
iana_time_zone	`DT_WSTR`	`nvarchar(100)`	100	`False`
phone	`DT_WSTR`	`nvarchar(100)`	100	`False`
url	`DT_WSTR`	`nvarchar(500)`	500	`False`
shared_phone_number	`DT_BOOL`	`bit`		`False`
locale_id	`DT_I8`	`bigint`		`False`
locale	`DT_WSTR`	`nvarchar(20)`	20	`False`
organization_id	`DT_I8`	`bigint`		`False`
role_type	`DT_I8`	`bigint`		`False`
verified	`DT_BOOL`	`bit`		`False`
external_id	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
tags_1	`DT_WSTR`	`nvarchar(50)`	50	`False`
tags_2	`DT_WSTR`	`nvarchar(50)`	50	`False`
tags_3	`DT_WSTR`	`nvarchar(50)`	50	`False`
tags_4	`DT_WSTR`	`nvarchar(50)`	50	`False`
tags_5	`DT_WSTR`	`nvarchar(50)`	50	`False`
alias	`DT_WSTR`	`nvarchar(255)`	255	`False`
shared	`DT_BOOL`	`bit`		`False`
shared_agent	`DT_BOOL`	`bit`		`False`
last_login_at	`DT_DBTIMESTAMP`	`datetime`		`False`
two_factor_auth_enabled	`DT_BOOL`	`bit`		`False`
signature	`DT_WSTR`	`nvarchar(80)`	80	`False`
details	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
notes	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
custom_role_id	`DT_I8`	`bigint`		`False`
moderator	`DT_BOOL`	`bit`		`False`
ticket_restriction	`DT_WSTR`	`nvarchar(80)`	80	`False`
only_private_comments	`DT_BOOL`	`bit`		`False`
restricted_agent	`DT_BOOL`	`bit`		`False`
suspended	`DT_BOOL`	`bit`		`False`
default_group_id	`DT_I8`	`bigint`		`False`
report_csv	`DT_BOOL`	`bit`		`False`
photo_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
photo_id	`DT_I8`	`bigint`		`False`
photo_file_name	`DT_WSTR`	`nvarchar(148)`	148	`False`
photo_content_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
photo_mapped_content_url	`DT_WSTR`	`nvarchar(500)`	500	`False`
photo_content_type	`DT_WSTR`	`nvarchar(40)`	40	`False`
photo_size	`DT_I8`	`bigint`		`False`
photo_width	`DT_I8`	`bigint`		`False`
photo_height	`DT_I8`	`bigint`		`False`
photo_inline	`DT_BOOL`	`bit`		`False`
photo_deleted	`DT_BOOL`	`bit`		`False`
photo_thumbnails	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
user_field_dt_[$parent.key$]	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
user_field_[$parent.key$]	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
id	`DT_I8`	`bigint`		`False`
name	`DT_WSTR`	`nvarchar(120)`	120	`False`
email	`DT_WSTR`	`nvarchar(160)`	160	`False`
alias	`DT_WSTR`	`nvarchar(255)`	255	`False`
time_zone	`DT_WSTR`	`nvarchar(104)`	104	`False`
phone	`DT_WSTR`	`nvarchar(80)`	80	`False`
shared_phone_number	`DT_BOOL`	`bit`		`False`
photo_id	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
locale_id	`DT_I8`	`bigint`		`False`
locale	`DT_WSTR`	`nvarchar(20)`	20	`False`
organization_id	`DT_I8`	`bigint`		`False`
organization_name	`DT_WSTR`	`nvarchar(200)`	200	`False`
role	`DT_WSTR`	`nvarchar(100)`	100	`False`
verified	`DT_BOOL`	`bit`		`False`
external_id	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
signature	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
details	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
notes	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
remote_photo_url	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
custom_role_id	`DT_I8`	`bigint`		`False`
moderator	`DT_BOOL`	`bit`		`False`
ticket_restriction	`DT_WSTR`	`nvarchar(80)`	80	`False`
only_private_comments	`DT_BOOL`	`bit`		`False`
restricted_agent	`DT_BOOL`	`bit`		`False`
suspended	`DT_BOOL`	`bit`		`False`
default_group_id	`DT_I8`	`bigint`		`False`
photo	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
user_fields	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
identities	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
$$user_ids	`DT_WSTR`	`nvarchar(2000)`	2000	`False`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Zendesk Connector in API Source component to read data or in API Destination component to read/write data:

Read User(s) by ID using API Source

Zendesk

Read User(s) by ID

SSIS API Source - Read from table or endpoint

Read User(s) by ID using API Destination

Zendesk

Read User(s) by ID

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get multiple users by ID(s)

Read multiple user information from Zendesk by ID(s)

SELECT * from get_users_by_ids
WITH(user_ids='1111,2222,3333')

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get multiple users by ID(s)

Read multiple user information from Zendesk by ID(s)

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from get_users_by_ids
WITH(user_ids=''1111,2222,3333'')';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_ZENDESK_IN_DATA_GATEWAY];