TCL / Support API / Incremental User Export, Cursor Based
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "start_time" "<integer>"
CkJsonObject_UpdateString $queryParams "cursor" "<string>"
CkJsonObject_UpdateString $queryParams "per_page" "<integer>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://example.zendesk.com/api/v2/incremental/users/cursor" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "after_cursor": "<string>",
# "after_url": "<string>",
# "before_cursor": "<string>",
# "before_url": "<string>",
# "end_of_stream": "<boolean>",
# "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": {
# "proidentbc0": -29354278.707036167,
# "fugiat_e_b": -98816029.91228342
# },
# "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": {
# "culpa14b": true
# },
# "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": {
# "in223": -78887847,
# "quis20_": 61629027.23513341
# },
# "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": {
# "aliquipe8": false
# },
# "verified": "<boolean>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set after_cursor [CkJsonObject_stringOf $jResp "after_cursor"]
set after_url [CkJsonObject_stringOf $jResp "after_url"]
set before_cursor [CkJsonObject_stringOf $jResp "before_cursor"]
set before_url [CkJsonObject_stringOf $jResp "before_url"]
set end_of_stream [CkJsonObject_stringOf $jResp "end_of_stream"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "users"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "users[i].name"]
set active [CkJsonObject_stringOf $jResp "users[i].active"]
set alias [CkJsonObject_stringOf $jResp "users[i].alias"]
set chat_only [CkJsonObject_stringOf $jResp "users[i].chat_only"]
set created_at [CkJsonObject_stringOf $jResp "users[i].created_at"]
set custom_role_id [CkJsonObject_stringOf $jResp "users[i].custom_role_id"]
set default_group_id [CkJsonObject_stringOf $jResp "users[i].default_group_id"]
set details [CkJsonObject_stringOf $jResp "users[i].details"]
set email [CkJsonObject_stringOf $jResp "users[i].email"]
set external_id [CkJsonObject_stringOf $jResp "users[i].external_id"]
set iana_time_zone [CkJsonObject_stringOf $jResp "users[i].iana_time_zone"]
set id [CkJsonObject_stringOf $jResp "users[i].id"]
set last_login_at [CkJsonObject_stringOf $jResp "users[i].last_login_at"]
set locale [CkJsonObject_stringOf $jResp "users[i].locale"]
set locale_id [CkJsonObject_stringOf $jResp "users[i].locale_id"]
set moderator [CkJsonObject_stringOf $jResp "users[i].moderator"]
set notes [CkJsonObject_stringOf $jResp "users[i].notes"]
set only_private_comments [CkJsonObject_stringOf $jResp "users[i].only_private_comments"]
set organization_id [CkJsonObject_stringOf $jResp "users[i].organization_id"]
set phone [CkJsonObject_stringOf $jResp "users[i].phone"]
set Proidentbc0 [CkJsonObject_stringOf $jResp "users[i].photo.proidentbc0"]
set Fugiat_e_b [CkJsonObject_stringOf $jResp "users[i].photo.fugiat_e_b"]
set remote_photo_url [CkJsonObject_stringOf $jResp "users[i].remote_photo_url"]
set report_csv [CkJsonObject_stringOf $jResp "users[i].report_csv"]
set restricted_agent [CkJsonObject_stringOf $jResp "users[i].restricted_agent"]
set role [CkJsonObject_stringOf $jResp "users[i].role"]
set role_type [CkJsonObject_stringOf $jResp "users[i].role_type"]
set v_shared [CkJsonObject_stringOf $jResp "users[i].shared"]
set shared_agent [CkJsonObject_stringOf $jResp "users[i].shared_agent"]
set shared_phone_number [CkJsonObject_stringOf $jResp "users[i].shared_phone_number"]
set signature [CkJsonObject_stringOf $jResp "users[i].signature"]
set suspended [CkJsonObject_stringOf $jResp "users[i].suspended"]
set tags [CkJsonObject_stringOf $jResp "users[i].tags"]
set ticket_restriction [CkJsonObject_stringOf $jResp "users[i].ticket_restriction"]
set time_zone [CkJsonObject_stringOf $jResp "users[i].time_zone"]
set two_factor_auth_enabled [CkJsonObject_stringOf $jResp "users[i].two_factor_auth_enabled"]
set updated_at [CkJsonObject_stringOf $jResp "users[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "users[i].url"]
set Culpa14b [CkJsonObject_BoolOf $jResp "users[i].user_fields.culpa14b"]
set verified [CkJsonObject_stringOf $jResp "users[i].verified"]
set In223 [CkJsonObject_IntOf $jResp "users[i].photo.in223"]
set Quis20_ [CkJsonObject_stringOf $jResp "users[i].photo.quis20_"]
set Aliquipe8 [CkJsonObject_BoolOf $jResp "users[i].user_fields.aliquipe8"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -G -d "start_time=%3Cinteger%3E"
-d "cursor=%3Cstring%3E"
-d "per_page=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/users/cursor
Postman Collection Item JSON
{
"name": "Incremental User Export, Cursor Based",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/users/cursor?start_time=<integer>&cursor=<string>&per_page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"users",
"cursor"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
},
{
"key": "cursor",
"value": "<string>",
"description": "The cursor pointer to work with for all subsequent exports after the initial request"
},
{
"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/cursor?start_time=<integer>&cursor=<string>&per_page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"users",
"cursor"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
},
{
"key": "cursor",
"value": "<string>",
"description": "The cursor pointer to work with for all subsequent exports after the initial request"
},
{
"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 \"after_cursor\": \"<string>\",\n \"after_url\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"before_url\": \"<string>\",\n \"end_of_stream\": \"<boolean>\",\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 \"proidentbc0\": -29354278.707036167,\n \"fugiat_e_b\": -98816029.91228342\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 \"culpa14b\": true\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 \"in223\": -78887847,\n \"quis20_\": 61629027.23513341\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 \"aliquipe8\": false\n },\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
