autoit / Support API / Incremental User Export, Time Based
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("start_time","<integer>")
$oQueryParams.UpdateString("per_page","<integer>")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/users",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "count": "<integer>",
; "end_of_stream": "<boolean>",
; "end_time": "<integer>",
; "next_page": "<string>",
; "users": [
; {
; "name": "<string>",
; "active": "<boolean>",
; "alias": "<string>",
; "chat_only": "<boolean>",
; "created_at": "<string>",
; "custom_role_id": "<integer>",
; "default_group_id": "<integer>",
; "details": "<string>",
; "email": "<string>",
; "external_id": "<string>",
; "iana_time_zone": "<string>",
; "id": "<integer>",
; "last_login_at": "<string>",
; "locale": "<string>",
; "locale_id": "<integer>",
; "moderator": "<boolean>",
; "notes": "<string>",
; "only_private_comments": "<boolean>",
; "organization_id": "<integer>",
; "phone": "<string>",
; "photo": {
; "adipisicing_be": -39386977,
; "culpa1": true,
; "id63": 47671826.614892066
; },
; "remote_photo_url": "<string>",
; "report_csv": "<boolean>",
; "restricted_agent": "<boolean>",
; "role": "<string>",
; "role_type": "<integer>",
; "shared": "<boolean>",
; "shared_agent": "<boolean>",
; "shared_phone_number": "<boolean>",
; "signature": "<string>",
; "suspended": "<boolean>",
; "tags": "<array>",
; "ticket_restriction": "<string>",
; "time_zone": "<string>",
; "two_factor_auth_enabled": "<boolean>",
; "updated_at": "<string>",
; "url": "<string>",
; "user_fields": {
; "Utcb6": -74003819
; },
; "verified": "<boolean>"
; },
; {
; "name": "<string>",
; "active": "<boolean>",
; "alias": "<string>",
; "chat_only": "<boolean>",
; "created_at": "<string>",
; "custom_role_id": "<integer>",
; "default_group_id": "<integer>",
; "details": "<string>",
; "email": "<string>",
; "external_id": "<string>",
; "iana_time_zone": "<string>",
; "id": "<integer>",
; "last_login_at": "<string>",
; "locale": "<string>",
; "locale_id": "<integer>",
; "moderator": "<boolean>",
; "notes": "<string>",
; "only_private_comments": "<boolean>",
; "organization_id": "<integer>",
; "phone": "<string>",
; "photo": {
; "Ut_4ed": 19247988,
; "laborum_0": true,
; "deserunt1c": -98204692,
; "enim87c": true,
; "ipsume0d": 97038646.85032353
; },
; "remote_photo_url": "<string>",
; "report_csv": "<boolean>",
; "restricted_agent": "<boolean>",
; "role": "<string>",
; "role_type": "<integer>",
; "shared": "<boolean>",
; "shared_agent": "<boolean>",
; "shared_phone_number": "<boolean>",
; "signature": "<string>",
; "suspended": "<boolean>",
; "tags": "<array>",
; "ticket_restriction": "<string>",
; "time_zone": "<string>",
; "two_factor_auth_enabled": "<boolean>",
; "updated_at": "<string>",
; "url": "<string>",
; "user_fields": {
; "tempor_5f": false,
; "commodo_e": -84252164
; },
; "verified": "<boolean>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sName
Local $sActive
Local $sAlias
Local $sChat_only
Local $sCreated_at
Local $sCustom_role_id
Local $sDefault_group_id
Local $sDetails
Local $sEmail
Local $sExternal_id
Local $sIana_time_zone
Local $sId
Local $sLast_login_at
Local $sLocale
Local $sLocale_id
Local $sModerator
Local $sNotes
Local $sOnly_private_comments
Local $sOrganization_id
Local $sPhone
Local $iAdipisicing_be
Local $bCulpa1
Local $sId63
Local $sRemote_photo_url
Local $sReport_csv
Local $sRestricted_agent
Local $sRole
Local $sRole_type
Local $sV_shared
Local $shared_agent
Local $shared_phone_number
Local $signature
Local $suspended
Local $sTags
Local $sTicket_restriction
Local $sTime_zone
Local $sTwo_factor_auth_enabled
Local $sUpdated_at
Local $sUrl
Local $iUtcb6
Local $sVerified
Local $iUt_4ed
Local $bLaborum_0
Local $iDeserunt1c
Local $bEnim87c
Local $sIpsume0d
Local $bTempor_5f
Local $iCommodo_e
Local $sCount = $oJResp.StringOf("count")
Local $sEnd_of_stream = $oJResp.StringOf("end_of_stream")
Local $sEnd_time = $oJResp.StringOf("end_time")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("users")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("users[i].name")
$sActive = $oJResp.StringOf("users[i].active")
$sAlias = $oJResp.StringOf("users[i].alias")
$sChat_only = $oJResp.StringOf("users[i].chat_only")
$sCreated_at = $oJResp.StringOf("users[i].created_at")
$sCustom_role_id = $oJResp.StringOf("users[i].custom_role_id")
$sDefault_group_id = $oJResp.StringOf("users[i].default_group_id")
$sDetails = $oJResp.StringOf("users[i].details")
$sEmail = $oJResp.StringOf("users[i].email")
$sExternal_id = $oJResp.StringOf("users[i].external_id")
$sIana_time_zone = $oJResp.StringOf("users[i].iana_time_zone")
$sId = $oJResp.StringOf("users[i].id")
$sLast_login_at = $oJResp.StringOf("users[i].last_login_at")
$sLocale = $oJResp.StringOf("users[i].locale")
$sLocale_id = $oJResp.StringOf("users[i].locale_id")
$sModerator = $oJResp.StringOf("users[i].moderator")
$sNotes = $oJResp.StringOf("users[i].notes")
$sOnly_private_comments = $oJResp.StringOf("users[i].only_private_comments")
$sOrganization_id = $oJResp.StringOf("users[i].organization_id")
$sPhone = $oJResp.StringOf("users[i].phone")
$iAdipisicing_be = $oJResp.IntOf("users[i].photo.adipisicing_be")
$bCulpa1 = $oJResp.BoolOf("users[i].photo.culpa1")
$sId63 = $oJResp.StringOf("users[i].photo.id63")
$sRemote_photo_url = $oJResp.StringOf("users[i].remote_photo_url")
$sReport_csv = $oJResp.StringOf("users[i].report_csv")
$sRestricted_agent = $oJResp.StringOf("users[i].restricted_agent")
$sRole = $oJResp.StringOf("users[i].role")
$sRole_type = $oJResp.StringOf("users[i].role_type")
$sV_shared = $oJResp.StringOf("users[i].shared")
$shared_agent = $oJResp.StringOf("users[i].shared_agent")
$shared_phone_number = $oJResp.StringOf("users[i].shared_phone_number")
$signature = $oJResp.StringOf("users[i].signature")
$suspended = $oJResp.StringOf("users[i].suspended")
$sTags = $oJResp.StringOf("users[i].tags")
$sTicket_restriction = $oJResp.StringOf("users[i].ticket_restriction")
$sTime_zone = $oJResp.StringOf("users[i].time_zone")
$sTwo_factor_auth_enabled = $oJResp.StringOf("users[i].two_factor_auth_enabled")
$sUpdated_at = $oJResp.StringOf("users[i].updated_at")
$sUrl = $oJResp.StringOf("users[i].url")
$iUtcb6 = $oJResp.IntOf("users[i].user_fields.Utcb6")
$sVerified = $oJResp.StringOf("users[i].verified")
$iUt_4ed = $oJResp.IntOf("users[i].photo.Ut_4ed")
$bLaborum_0 = $oJResp.BoolOf("users[i].photo.laborum_0")
$iDeserunt1c = $oJResp.IntOf("users[i].photo.deserunt1c")
$bEnim87c = $oJResp.BoolOf("users[i].photo.enim87c")
$sIpsume0d = $oJResp.StringOf("users[i].photo.ipsume0d")
$bTempor_5f = $oJResp.BoolOf("users[i].user_fields.tempor_5f")
$iCommodo_e = $oJResp.IntOf("users[i].user_fields.commodo_e")
$i = $i + 1
Wend
Curl Command
curl -u login:password -G -d "start_time=%3Cinteger%3E"
-d "per_page=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/users
Postman Collection Item JSON
{
"name": "Incremental User Export, Time Based",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/users?start_time=<integer>&per_page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"users"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
},
{
"key": "per_page",
"value": "<integer>",
"description": "The number of records to return per page"
}
]
},
"description": "#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Users sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/users?start_time=<integer>&per_page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"users"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
},
{
"key": "per_page",
"value": "<integer>",
"description": "The number of records to return per page"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"end_of_stream\": \"<boolean>\",\n \"end_time\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"users\": [\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"adipisicing_be\": -39386977,\n \"culpa1\": true,\n \"id63\": 47671826.614892066\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"Utcb6\": -74003819\n },\n \"verified\": \"<boolean>\"\n },\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"Ut_4ed\": 19247988,\n \"laborum_0\": true,\n \"deserunt1c\": -98204692,\n \"enim87c\": true,\n \"ipsume0d\": 97038646.85032353\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"tempor_5f\": false,\n \"commodo_e\": -84252164\n },\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
