Zendesk Connector
Documentation
Version: 9
Documentation
Home » API Integration Hub » Zendesk Connector » EndPoints > Read Users (Incremental) changed after a specified date

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 Help]

Parameters

Parameter Label Required Options Description
start_time Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss) 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
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)
exclude_deleted Exclude Deleted NO
Option Value
true true
false false
Whether or not you'd like to exclude deleted tickets from the response
per_page Page Size (Default 1000) NO 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 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