C / Support API / Incremental User Export, Time Based
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *name;
const char *active;
const char *alias;
const char *chat_only;
const char *created_at;
const char *custom_role_id;
const char *default_group_id;
const char *details;
const char *email;
const char *external_id;
const char *iana_time_zone;
const char *id;
const char *last_login_at;
const char *locale;
const char *locale_id;
const char *moderator;
const char *notes;
const char *only_private_comments;
const char *organization_id;
const char *phone;
int Adipisicing_be;
BOOL Culpa1;
const char *Id63;
const char *remote_photo_url;
const char *report_csv;
const char *restricted_agent;
const char *role;
const char *role_type;
const char *v_shared;
const char *shared_agent;
const char *shared_phone_number;
const char *signature;
const char *suspended;
const char *tags;
const char *ticket_restriction;
const char *time_zone;
const char *two_factor_auth_enabled;
const char *updated_at;
const char *url;
int Utcb6;
const char *verified;
int Ut_4ed;
BOOL Laborum_0;
int Deserunt1c;
BOOL Enim87c;
const char *Ipsume0d;
BOOL Tempor_5f;
int Commodo_e;
const char *count;
const char *end_of_stream;
const char *end_time;
const char *next_page;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"start_time","<integer>");
CkJsonObject_UpdateString(queryParams,"per_page","<integer>");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_QuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/incremental/users",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
count = CkJsonObject_stringOf(jResp,"count");
end_of_stream = CkJsonObject_stringOf(jResp,"end_of_stream");
end_time = CkJsonObject_stringOf(jResp,"end_time");
next_page = CkJsonObject_stringOf(jResp,"next_page");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"users");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
name = CkJsonObject_stringOf(jResp,"users[i].name");
active = CkJsonObject_stringOf(jResp,"users[i].active");
alias = CkJsonObject_stringOf(jResp,"users[i].alias");
chat_only = CkJsonObject_stringOf(jResp,"users[i].chat_only");
created_at = CkJsonObject_stringOf(jResp,"users[i].created_at");
custom_role_id = CkJsonObject_stringOf(jResp,"users[i].custom_role_id");
default_group_id = CkJsonObject_stringOf(jResp,"users[i].default_group_id");
details = CkJsonObject_stringOf(jResp,"users[i].details");
email = CkJsonObject_stringOf(jResp,"users[i].email");
external_id = CkJsonObject_stringOf(jResp,"users[i].external_id");
iana_time_zone = CkJsonObject_stringOf(jResp,"users[i].iana_time_zone");
id = CkJsonObject_stringOf(jResp,"users[i].id");
last_login_at = CkJsonObject_stringOf(jResp,"users[i].last_login_at");
locale = CkJsonObject_stringOf(jResp,"users[i].locale");
locale_id = CkJsonObject_stringOf(jResp,"users[i].locale_id");
moderator = CkJsonObject_stringOf(jResp,"users[i].moderator");
notes = CkJsonObject_stringOf(jResp,"users[i].notes");
only_private_comments = CkJsonObject_stringOf(jResp,"users[i].only_private_comments");
organization_id = CkJsonObject_stringOf(jResp,"users[i].organization_id");
phone = CkJsonObject_stringOf(jResp,"users[i].phone");
Adipisicing_be = CkJsonObject_IntOf(jResp,"users[i].photo.adipisicing_be");
Culpa1 = CkJsonObject_BoolOf(jResp,"users[i].photo.culpa1");
Id63 = CkJsonObject_stringOf(jResp,"users[i].photo.id63");
remote_photo_url = CkJsonObject_stringOf(jResp,"users[i].remote_photo_url");
report_csv = CkJsonObject_stringOf(jResp,"users[i].report_csv");
restricted_agent = CkJsonObject_stringOf(jResp,"users[i].restricted_agent");
role = CkJsonObject_stringOf(jResp,"users[i].role");
role_type = CkJsonObject_stringOf(jResp,"users[i].role_type");
v_shared = CkJsonObject_stringOf(jResp,"users[i].shared");
shared_agent = CkJsonObject_stringOf(jResp,"users[i].shared_agent");
shared_phone_number = CkJsonObject_stringOf(jResp,"users[i].shared_phone_number");
signature = CkJsonObject_stringOf(jResp,"users[i].signature");
suspended = CkJsonObject_stringOf(jResp,"users[i].suspended");
tags = CkJsonObject_stringOf(jResp,"users[i].tags");
ticket_restriction = CkJsonObject_stringOf(jResp,"users[i].ticket_restriction");
time_zone = CkJsonObject_stringOf(jResp,"users[i].time_zone");
two_factor_auth_enabled = CkJsonObject_stringOf(jResp,"users[i].two_factor_auth_enabled");
updated_at = CkJsonObject_stringOf(jResp,"users[i].updated_at");
url = CkJsonObject_stringOf(jResp,"users[i].url");
Utcb6 = CkJsonObject_IntOf(jResp,"users[i].user_fields.Utcb6");
verified = CkJsonObject_stringOf(jResp,"users[i].verified");
Ut_4ed = CkJsonObject_IntOf(jResp,"users[i].photo.Ut_4ed");
Laborum_0 = CkJsonObject_BoolOf(jResp,"users[i].photo.laborum_0");
Deserunt1c = CkJsonObject_IntOf(jResp,"users[i].photo.deserunt1c");
Enim87c = CkJsonObject_BoolOf(jResp,"users[i].photo.enim87c");
Ipsume0d = CkJsonObject_stringOf(jResp,"users[i].photo.ipsume0d");
Tempor_5f = CkJsonObject_BoolOf(jResp,"users[i].user_fields.tempor_5f");
Commodo_e = CkJsonObject_IntOf(jResp,"users[i].user_fields.commodo_e");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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}"
}
]
}
