Chilkat Online Tools

Perl / Support API / Incremental User Export, Cursor Based

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("start_time","<integer>");
$queryParams->UpdateString("cursor","<string>");
$queryParams->UpdateString("per_page","<integer>");

$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/users/cursor",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$after_cursor = $jResp->stringOf("after_cursor");
$after_url = $jResp->stringOf("after_url");
$before_cursor = $jResp->stringOf("before_cursor");
$before_url = $jResp->stringOf("before_url");
$end_of_stream = $jResp->stringOf("end_of_stream");
$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");
    $Proidentbc0 = $jResp->stringOf("users[i].photo.proidentbc0");
    $Fugiat_e_b = $jResp->stringOf("users[i].photo.fugiat_e_b");
    $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");
    $Culpa14b = $jResp->BoolOf("users[i].user_fields.culpa14b");
    $verified = $jResp->stringOf("users[i].verified");
    $In223 = $jResp->IntOf("users[i].photo.in223");
    $Quis20_ = $jResp->stringOf("users[i].photo.quis20_");
    $Aliquipe8 = $jResp->BoolOf("users[i].user_fields.aliquipe8");
    $i = $i + 1;
}

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}"
    }
  ]
}