Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/users/me",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "user": {
// "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": {
// "dolore50": -51881550.25541992
// },
// "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": {
// "deserunt_c4": -61141403
// },
// "verified": "<boolean>",
// "authenticity_token": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcName = loJResp.StringOf("user.name")
lcActive = loJResp.StringOf("user.active")
lcAlias = loJResp.StringOf("user.alias")
lcChat_only = loJResp.StringOf("user.chat_only")
lcCreated_at = loJResp.StringOf("user.created_at")
lcCustom_role_id = loJResp.StringOf("user.custom_role_id")
lcDefault_group_id = loJResp.StringOf("user.default_group_id")
lcDetails = loJResp.StringOf("user.details")
lcV_Email = loJResp.StringOf("user.email")
lcExternal_id = loJResp.StringOf("user.external_id")
lcIana_time_zone = loJResp.StringOf("user.iana_time_zone")
lcId = loJResp.StringOf("user.id")
lcLast_login_at = loJResp.StringOf("user.last_login_at")
lcLocale = loJResp.StringOf("user.locale")
lcLocale_id = loJResp.StringOf("user.locale_id")
lcModerator = loJResp.StringOf("user.moderator")
lcNotes = loJResp.StringOf("user.notes")
lcOnly_private_comments = loJResp.StringOf("user.only_private_comments")
lcOrganization_id = loJResp.StringOf("user.organization_id")
lcPhone = loJResp.StringOf("user.phone")
lcDolore50 = loJResp.StringOf("user.photo.dolore50")
lcRemote_photo_url = loJResp.StringOf("user.remote_photo_url")
lcReport_csv = loJResp.StringOf("user.report_csv")
lcRestricted_agent = loJResp.StringOf("user.restricted_agent")
lcRole = loJResp.StringOf("user.role")
lcRole_type = loJResp.StringOf("user.role_type")
lcV_Shared = loJResp.StringOf("user.shared")
lcShared_agent = loJResp.StringOf("user.shared_agent")
lcShared_phone_number = loJResp.StringOf("user.shared_phone_number")
lcSignature = loJResp.StringOf("user.signature")
lcSuspended = loJResp.StringOf("user.suspended")
lcTags = loJResp.StringOf("user.tags")
lcTicket_restriction = loJResp.StringOf("user.ticket_restriction")
lcTime_zone = loJResp.StringOf("user.time_zone")
lcTwo_factor_auth_enabled = loJResp.StringOf("user.two_factor_auth_enabled")
lcUpdated_at = loJResp.StringOf("user.updated_at")
lcV_Url = loJResp.StringOf("user.url")
lnDeserunt_c4 = loJResp.IntOf("user.user_fields.deserunt_c4")
lcVerified = loJResp.StringOf("user.verified")
lcAuthenticity_token = loJResp.StringOf("user.authenticity_token")
release loHttp
release loSbResponseBody
release loJResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/me
Postman Collection Item JSON
{
"name": "Show Self",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/me",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"me"
]
},
"description": "#### Allowed For\n\n* Anonymous users\n\n#### Authenticity Token\n\nThe endpoint returns an `authenticity_token`. Zendesk API calls made by end users from a Zendesk help center must include this token in the `X-CSRF-Token` HTTP header. This helps prevent [cross-site request forgery (CSRF)](https://en.wikipedia.org/wiki/Cross-site_request_forgery) attacks.\n\nFor an example using an authenticity token, see the AJAX request in the [Upgrading from Templating API v1](https://developer.zendesk.com/documentation/help_center/help-center-templates/v1#jquery) documentation.\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/users/me",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"me"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\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 \"dolore50\": -51881550.25541992\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 \"deserunt_c4\": -61141403\n },\n \"verified\": \"<boolean>\",\n \"authenticity_token\": \"<string>\"\n }\n}"
}
]
}
