Foxpro / Support API / Incremental User Export, Time Based
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcActive
LOCAL lcAlias
LOCAL lcChat_only
LOCAL lcCreated_at
LOCAL lcCustom_role_id
LOCAL lcDefault_group_id
LOCAL lcDetails
LOCAL lcEmail
LOCAL lcExternal_id
LOCAL lcIana_time_zone
LOCAL lcId
LOCAL lcLast_login_at
LOCAL lcLocale
LOCAL lcLocale_id
LOCAL lcModerator
LOCAL lcNotes
LOCAL lcOnly_private_comments
LOCAL lcOrganization_id
LOCAL lcPhone
LOCAL lnAdipisicing_be
LOCAL lnCulpa1
LOCAL lcId63
LOCAL lcRemote_photo_url
LOCAL lcReport_csv
LOCAL lcRestricted_agent
LOCAL lcRole
LOCAL lcRole_type
LOCAL lcV_shared
LOCAL lcShared_agent
LOCAL lcShared_phone_number
LOCAL lcSignature
LOCAL lcSuspended
LOCAL lcTags
LOCAL lcTicket_restriction
LOCAL lcTime_zone
LOCAL lcTwo_factor_auth_enabled
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL lnUtcb6
LOCAL lcVerified
LOCAL lnUt_4ed
LOCAL lnLaborum_0
LOCAL lnDeserunt1c
LOCAL lnEnim87c
LOCAL lcIpsume0d
LOCAL lnTempor_5f
LOCAL lnCommodo_e
LOCAL lcCount
LOCAL lcEnd_of_stream
LOCAL lcEnd_time
LOCAL lcNext_page
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("start_time","<integer>")
loQueryParams.UpdateString("per_page","<integer>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/users",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcCount = loJResp.StringOf("count")
lcEnd_of_stream = loJResp.StringOf("end_of_stream")
lcEnd_time = loJResp.StringOf("end_time")
lcNext_page = loJResp.StringOf("next_page")
i = 0
lnCount_i = loJResp.SizeOfArray("users")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("users[i].name")
lcActive = loJResp.StringOf("users[i].active")
lcAlias = loJResp.StringOf("users[i].alias")
lcChat_only = loJResp.StringOf("users[i].chat_only")
lcCreated_at = loJResp.StringOf("users[i].created_at")
lcCustom_role_id = loJResp.StringOf("users[i].custom_role_id")
lcDefault_group_id = loJResp.StringOf("users[i].default_group_id")
lcDetails = loJResp.StringOf("users[i].details")
lcEmail = loJResp.StringOf("users[i].email")
lcExternal_id = loJResp.StringOf("users[i].external_id")
lcIana_time_zone = loJResp.StringOf("users[i].iana_time_zone")
lcId = loJResp.StringOf("users[i].id")
lcLast_login_at = loJResp.StringOf("users[i].last_login_at")
lcLocale = loJResp.StringOf("users[i].locale")
lcLocale_id = loJResp.StringOf("users[i].locale_id")
lcModerator = loJResp.StringOf("users[i].moderator")
lcNotes = loJResp.StringOf("users[i].notes")
lcOnly_private_comments = loJResp.StringOf("users[i].only_private_comments")
lcOrganization_id = loJResp.StringOf("users[i].organization_id")
lcPhone = loJResp.StringOf("users[i].phone")
lnAdipisicing_be = loJResp.IntOf("users[i].photo.adipisicing_be")
lnCulpa1 = loJResp.BoolOf("users[i].photo.culpa1")
lcId63 = loJResp.StringOf("users[i].photo.id63")
lcRemote_photo_url = loJResp.StringOf("users[i].remote_photo_url")
lcReport_csv = loJResp.StringOf("users[i].report_csv")
lcRestricted_agent = loJResp.StringOf("users[i].restricted_agent")
lcRole = loJResp.StringOf("users[i].role")
lcRole_type = loJResp.StringOf("users[i].role_type")
lcV_shared = loJResp.StringOf("users[i].shared")
lcShared_agent = loJResp.StringOf("users[i].shared_agent")
lcShared_phone_number = loJResp.StringOf("users[i].shared_phone_number")
lcSignature = loJResp.StringOf("users[i].signature")
lcSuspended = loJResp.StringOf("users[i].suspended")
lcTags = loJResp.StringOf("users[i].tags")
lcTicket_restriction = loJResp.StringOf("users[i].ticket_restriction")
lcTime_zone = loJResp.StringOf("users[i].time_zone")
lcTwo_factor_auth_enabled = loJResp.StringOf("users[i].two_factor_auth_enabled")
lcUpdated_at = loJResp.StringOf("users[i].updated_at")
lcUrl = loJResp.StringOf("users[i].url")
lnUtcb6 = loJResp.IntOf("users[i].user_fields.Utcb6")
lcVerified = loJResp.StringOf("users[i].verified")
lnUt_4ed = loJResp.IntOf("users[i].photo.Ut_4ed")
lnLaborum_0 = loJResp.BoolOf("users[i].photo.laborum_0")
lnDeserunt1c = loJResp.IntOf("users[i].photo.deserunt1c")
lnEnim87c = loJResp.BoolOf("users[i].photo.enim87c")
lcIpsume0d = loJResp.StringOf("users[i].photo.ipsume0d")
lnTempor_5f = loJResp.BoolOf("users[i].user_fields.tempor_5f")
lnCommodo_e = loJResp.IntOf("users[i].user_fields.commodo_e")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
