Reference

Endpoint Read Users (Incremental) changed after a specified date

Name

get_users_incr

Description

Get a list of users changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API reference]

Parameters

Parameter

Required

Options

Name: start_time

Label: Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)

YES

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Name: exclude_deleted

Label: Exclude Deleted

Whether or not you'd like to exclude deleted tickets from the response

Option	Value
true	true
false	false

Name: per_page

Label: Page Size (Default 1000)

Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.

Output Columns

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

If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

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

Required columns that you need to supply are bolded.

Examples

SSIS

Use Zendesk Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Zendesk

Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.

Zendesk

Read Users (Incremental) changed after a specified date

Required Parameters
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)	Fill-in the parameter...
Optional Parameters
Exclude Deleted
Page Size (Default 1000)
NextUrlAttributeOrExpr	$.after_url
NextUrlEndIndicator	true
StopIndicatorAttributeOrExpr	$.end_of_stream

SSIS API Source - Read from table or endpoint

API Destination

API Destination - Zendesk

Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.

Zendesk

Read Users (Incremental) changed after a specified date

Required Parameters
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)	Fill-in the parameter...
Optional Parameters
Exclude Deleted
Page Size (Default 1000)
NextUrlAttributeOrExpr	$.after_url
NextUrlEndIndicator	true
StopIndicatorAttributeOrExpr	$.end_of_stream

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get all users (incremental) modified after ceratin date/time

Read users modified after ceratin date/time. This is incremental data fetch. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option in the target. Only choose Update + Insert for Incremental fetch.

SELECT * FROM get_users_incr
WITH(
	    start_time='2012-01-31T00:00:00' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time='yesterday' --modified after yesterday
	  --start_time='now-5h' --modified after current time minus 5 hours
	  --start_time='today-60s' --modified after today minus 60 seconds
	  --start_time='weekstart' --modified after weekstart
	  --start_time='monthstart-1d' --modified after month start minus 1 day
	  --start_time='yearstart-1d' --modified after year start minus 1 day
	  --start_time='yearstart+1d' --modified after year start plus 1 day
	  --start_time='yearend+1d' --modified after year end plus 1 day
)

SQL Server

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

Get all users (incremental) modified after ceratin date/time

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_users_incr
WITH(
	    start_time=''2012-01-31T00:00:00'' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time=''yesterday'' --modified after yesterday
	  --start_time=''now-5h'' --modified after current time minus 5 hours
	  --start_time=''today-60s'' --modified after today minus 60 seconds
	  --start_time=''weekstart'' --modified after weekstart
	  --start_time=''monthstart-1d'' --modified after month start minus 1 day
	  --start_time=''yearstart-1d'' --modified after year start minus 1 day
	  --start_time=''yearstart+1d'' --modified after year start plus 1 day
	  --start_time=''yearend+1d'' --modified after year end plus 1 day
)';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];