Delphi (DLL) / Support API / Incremental User Export, Time Based
Back to Collection Items
var
begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');CkJsonObject_UpdateString(queryParams,'start_time','<integer>');CkJsonObject_UpdateString(queryParams,'per_page','<integer>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);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;
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}"
}
]
}
