EndPoint Read Users (Incremental) changed after a specified date

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

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

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

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)

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

Required columns that you need to supply are bolded.