Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "login"
http.password = "password"
let queryParams = CkoJsonObject()!
queryParams.update("role", value: "end-user")
queryParams.update("role[]", value: "<string>")
queryParams.update("permission_set", value: "<integer>")
queryParams.update("external_id", value: "<string>")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://example.zendesk.com/api/v2/users", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "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": {
// "in1f": false,
// "cillumb5": true
// },
// "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": {
// "nisi_e": "commodo exercitation consequat"
// },
// "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": {
// "ut69": true,
// "magna_4": -92520384
// },
// "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": {
// "Loremcc": 52379422,
// "dolore7": true,
// "pariaturf": "magna consectet"
// },
// "verified": "<boolean>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var name: String?
var active: String?
var alias: String?
var chat_only: String?
var created_at: String?
var custom_role_id: String?
var default_group_id: String?
var details: String?
var email: String?
var external_id: String?
var iana_time_zone: String?
var id: String?
var last_login_at: String?
var locale: String?
var locale_id: String?
var moderator: String?
var notes: String?
var only_private_comments: String?
var organization_id: String?
var phone: String?
var In1f: Bool
var Cillumb5: Bool
var remote_photo_url: String?
var report_csv: String?
var restricted_agent: String?
var role: String?
var role_type: String?
var v_shared: String?
var shared_agent: String?
var shared_phone_number: String?
var signature: String?
var suspended: String?
var tags: String?
var ticket_restriction: String?
var time_zone: String?
var two_factor_auth_enabled: String?
var updated_at: String?
var url: String?
var Nisi_e: String?
var verified: String?
var Ut69: Bool
var Magna_4: Int
var Loremcc: Int
var Dolore7: Bool
var Pariaturf: String?
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "users").intValue
while i < count_i {
jResp.i = i
name = jResp.string(of: "users[i].name")
active = jResp.string(of: "users[i].active")
alias = jResp.string(of: "users[i].alias")
chat_only = jResp.string(of: "users[i].chat_only")
created_at = jResp.string(of: "users[i].created_at")
custom_role_id = jResp.string(of: "users[i].custom_role_id")
default_group_id = jResp.string(of: "users[i].default_group_id")
details = jResp.string(of: "users[i].details")
email = jResp.string(of: "users[i].email")
external_id = jResp.string(of: "users[i].external_id")
iana_time_zone = jResp.string(of: "users[i].iana_time_zone")
id = jResp.string(of: "users[i].id")
last_login_at = jResp.string(of: "users[i].last_login_at")
locale = jResp.string(of: "users[i].locale")
locale_id = jResp.string(of: "users[i].locale_id")
moderator = jResp.string(of: "users[i].moderator")
notes = jResp.string(of: "users[i].notes")
only_private_comments = jResp.string(of: "users[i].only_private_comments")
organization_id = jResp.string(of: "users[i].organization_id")
phone = jResp.string(of: "users[i].phone")
In1f = jResp.bool(of: "users[i].photo.in1f")
Cillumb5 = jResp.bool(of: "users[i].photo.cillumb5")
remote_photo_url = jResp.string(of: "users[i].remote_photo_url")
report_csv = jResp.string(of: "users[i].report_csv")
restricted_agent = jResp.string(of: "users[i].restricted_agent")
role = jResp.string(of: "users[i].role")
role_type = jResp.string(of: "users[i].role_type")
v_shared = jResp.string(of: "users[i].shared")
shared_agent = jResp.string(of: "users[i].shared_agent")
shared_phone_number = jResp.string(of: "users[i].shared_phone_number")
signature = jResp.string(of: "users[i].signature")
suspended = jResp.string(of: "users[i].suspended")
tags = jResp.string(of: "users[i].tags")
ticket_restriction = jResp.string(of: "users[i].ticket_restriction")
time_zone = jResp.string(of: "users[i].time_zone")
two_factor_auth_enabled = jResp.string(of: "users[i].two_factor_auth_enabled")
updated_at = jResp.string(of: "users[i].updated_at")
url = jResp.string(of: "users[i].url")
Nisi_e = jResp.string(of: "users[i].user_fields.nisi_e")
verified = jResp.string(of: "users[i].verified")
Ut69 = jResp.bool(of: "users[i].photo.ut69")
Magna_4 = jResp.int(of: "users[i].photo.magna_4").intValue
Loremcc = jResp.int(of: "users[i].user_fields.Loremcc").intValue
Dolore7 = jResp.bool(of: "users[i].user_fields.dolore7")
Pariaturf = jResp.string(of: "users[i].user_fields.pariaturf")
i = i + 1
}
}
Curl Command
curl -u login:password -G -d "role=end-user"
-d "role[]=%3Cstring%3E"
-d "permission_set=%3Cinteger%3E"
-d "external_id=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users
Postman Collection Item JSON
{
"name": "List Users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users?role=end-user&role[]=<string>&permission_set=<integer>&external_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "role",
"value": "end-user",
"description": "Filters the results by role. Possible values are \"end-user\", \"agent\", or \"admin\"\n"
},
{
"key": "role[]",
"value": "<string>",
"description": "Filters the results by more than one role using the format `role[]={role}&role[]={role}`\n"
},
{
"key": "permission_set",
"value": "<integer>",
"description": "For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request"
},
{
"key": "external_id",
"value": "<string>",
"description": "List users by external id. External id has to be unique for each user under the same account."
}
]
},
"description": "#### Pagination\n\n* Cursor pagination (recommended)\n* Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Admins, Agents and Light Agents\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?role=end-user&role[]=<string>&permission_set=<integer>&external_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users"
],
"query": [
{
"key": "role",
"value": "end-user",
"description": "Filters the results by role. Possible values are \"end-user\", \"agent\", or \"admin\"\n"
},
{
"key": "role[]",
"value": "<string>",
"description": "Filters the results by more than one role using the format `role[]={role}&role[]={role}`\n"
},
{
"key": "permission_set",
"value": "<integer>",
"description": "For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request"
},
{
"key": "external_id",
"value": "<string>",
"description": "List users by external id. External id has to be unique for each user under the same account."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\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 \"in1f\": false,\n \"cillumb5\": true\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 \"nisi_e\": \"commodo exercitation consequat\"\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 \"ut69\": true,\n \"magna_4\": -92520384\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 \"Loremcc\": 52379422,\n \"dolore7\": true,\n \"pariaturf\": \"magna consectet\"\n },\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
