Powershell / Support API / Incremental User Export, Time Based
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("start_time","<integer>")
$queryParams.UpdateString("per_page","<integer>")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/users",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$count = $jResp.StringOf("count")
$end_of_stream = $jResp.StringOf("end_of_stream")
$end_time = $jResp.StringOf("end_time")
$next_page = $jResp.StringOf("next_page")
$i = 0
$count_i = $jResp.SizeOfArray("users")
while ($i -lt $count_i) {
$jResp.I = $i
$name = $jResp.StringOf("users[i].name")
$active = $jResp.StringOf("users[i].active")
$alias = $jResp.StringOf("users[i].alias")
$chat_only = $jResp.StringOf("users[i].chat_only")
$created_at = $jResp.StringOf("users[i].created_at")
$custom_role_id = $jResp.StringOf("users[i].custom_role_id")
$default_group_id = $jResp.StringOf("users[i].default_group_id")
$details = $jResp.StringOf("users[i].details")
$email = $jResp.StringOf("users[i].email")
$external_id = $jResp.StringOf("users[i].external_id")
$iana_time_zone = $jResp.StringOf("users[i].iana_time_zone")
$id = $jResp.StringOf("users[i].id")
$last_login_at = $jResp.StringOf("users[i].last_login_at")
$locale = $jResp.StringOf("users[i].locale")
$locale_id = $jResp.StringOf("users[i].locale_id")
$moderator = $jResp.StringOf("users[i].moderator")
$notes = $jResp.StringOf("users[i].notes")
$only_private_comments = $jResp.StringOf("users[i].only_private_comments")
$organization_id = $jResp.StringOf("users[i].organization_id")
$phone = $jResp.StringOf("users[i].phone")
$Adipisicing_be = $jResp.IntOf("users[i].photo.adipisicing_be")
$Culpa1 = $jResp.BoolOf("users[i].photo.culpa1")
$Id63 = $jResp.StringOf("users[i].photo.id63")
$remote_photo_url = $jResp.StringOf("users[i].remote_photo_url")
$report_csv = $jResp.StringOf("users[i].report_csv")
$restricted_agent = $jResp.StringOf("users[i].restricted_agent")
$role = $jResp.StringOf("users[i].role")
$role_type = $jResp.StringOf("users[i].role_type")
$v_shared = $jResp.StringOf("users[i].shared")
$shared_agent = $jResp.StringOf("users[i].shared_agent")
$shared_phone_number = $jResp.StringOf("users[i].shared_phone_number")
$signature = $jResp.StringOf("users[i].signature")
$suspended = $jResp.StringOf("users[i].suspended")
$tags = $jResp.StringOf("users[i].tags")
$ticket_restriction = $jResp.StringOf("users[i].ticket_restriction")
$time_zone = $jResp.StringOf("users[i].time_zone")
$two_factor_auth_enabled = $jResp.StringOf("users[i].two_factor_auth_enabled")
$updated_at = $jResp.StringOf("users[i].updated_at")
$url = $jResp.StringOf("users[i].url")
$Utcb6 = $jResp.IntOf("users[i].user_fields.Utcb6")
$verified = $jResp.StringOf("users[i].verified")
$Ut_4ed = $jResp.IntOf("users[i].photo.Ut_4ed")
$Laborum_0 = $jResp.BoolOf("users[i].photo.laborum_0")
$Deserunt1c = $jResp.IntOf("users[i].photo.deserunt1c")
$Enim87c = $jResp.BoolOf("users[i].photo.enim87c")
$Ipsume0d = $jResp.StringOf("users[i].photo.ipsume0d")
$Tempor_5f = $jResp.BoolOf("users[i].user_fields.tempor_5f")
$Commodo_e = $jResp.IntOf("users[i].user_fields.commodo_e")
$i = $i + 1
}
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}"
}
]
}
