Unicode C++ / Support API / Incremental User Export, Time Based
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); queryParams.UpdateString(L"start_time",L"<integer>"); queryParams.UpdateString(L"per_page",L"<integer>"); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); name = jResp.stringOf(L"users[i].name"); active = jResp.stringOf(L"users[i].active"); alias = jResp.stringOf(L"users[i].alias"); chat_only = jResp.stringOf(L"users[i].chat_only"); created_at = jResp.stringOf(L"users[i].created_at"); custom_role_id = jResp.stringOf(L"users[i].custom_role_id"); default_group_id = jResp.stringOf(L"users[i].default_group_id"); details = jResp.stringOf(L"users[i].details"); email = jResp.stringOf(L"users[i].email"); external_id = jResp.stringOf(L"users[i].external_id"); iana_time_zone = jResp.stringOf(L"users[i].iana_time_zone"); id = jResp.stringOf(L"users[i].id"); last_login_at = jResp.stringOf(L"users[i].last_login_at"); locale = jResp.stringOf(L"users[i].locale"); locale_id = jResp.stringOf(L"users[i].locale_id"); moderator = jResp.stringOf(L"users[i].moderator"); notes = jResp.stringOf(L"users[i].notes"); only_private_comments = jResp.stringOf(L"users[i].only_private_comments"); organization_id = jResp.stringOf(L"users[i].organization_id"); phone = jResp.stringOf(L"users[i].phone"); Adipisicing_be = jResp.IntOf(L"users[i].photo.adipisicing_be"); Culpa1 = jResp.BoolOf(L"users[i].photo.culpa1"); Id63 = jResp.stringOf(L"users[i].photo.id63"); remote_photo_url = jResp.stringOf(L"users[i].remote_photo_url"); report_csv = jResp.stringOf(L"users[i].report_csv"); restricted_agent = jResp.stringOf(L"users[i].restricted_agent"); role = jResp.stringOf(L"users[i].role"); role_type = jResp.stringOf(L"users[i].role_type"); v_shared = jResp.stringOf(L"users[i].shared"); shared_agent = jResp.stringOf(L"users[i].shared_agent"); shared_phone_number = jResp.stringOf(L"users[i].shared_phone_number"); signature = jResp.stringOf(L"users[i].signature"); suspended = jResp.stringOf(L"users[i].suspended"); tags = jResp.stringOf(L"users[i].tags"); ticket_restriction = jResp.stringOf(L"users[i].ticket_restriction"); time_zone = jResp.stringOf(L"users[i].time_zone"); two_factor_auth_enabled = jResp.stringOf(L"users[i].two_factor_auth_enabled"); updated_at = jResp.stringOf(L"users[i].updated_at"); url = jResp.stringOf(L"users[i].url"); Utcb6 = jResp.IntOf(L"users[i].user_fields.Utcb6"); verified = jResp.stringOf(L"users[i].verified"); Ut_4ed = jResp.IntOf(L"users[i].photo.Ut_4ed"); Laborum_0 = jResp.BoolOf(L"users[i].photo.laborum_0"); Deserunt1c = jResp.IntOf(L"users[i].photo.deserunt1c"); Enim87c = jResp.BoolOf(L"users[i].photo.enim87c"); Ipsume0d = jResp.stringOf(L"users[i].photo.ipsume0d"); Tempor_5f = jResp.BoolOf(L"users[i].user_fields.tempor_5f"); Commodo_e = jResp.IntOf(L"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}"
}
]
}
