Python / Support API / Incremental User Export, Time Based
Back to Collection Items
import sys
import chilkat
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("password")
queryParams = chilkat.CkJsonObject()
queryParams.UpdateString("start_time","<integer>")
queryParams.UpdateString("per_page","<integer>")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/users",queryParams)
if (http.get_LastMethodSuccess() == False):
print(http.lastErrorText())
sys.exit()
sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.header())
print("Failed.")
sys.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 < count_i :
jResp.put_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}"
}
]
}
