Objective-C / Support API / Search Users
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"query" value: @"<string>"];
[queryParams UpdateString: @"external_id" value: @"<string>"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://example.zendesk.com/api/v2/users/search" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *name = 0;
NSString *active = 0;
NSString *alias = 0;
NSString *chat_only = 0;
NSString *created_at = 0;
NSString *custom_role_id = 0;
NSString *default_group_id = 0;
NSString *details = 0;
NSString *email = 0;
NSString *external_id = 0;
NSString *iana_time_zone = 0;
NSString *id = 0;
NSString *last_login_at = 0;
NSString *locale = 0;
NSString *locale_id = 0;
NSString *moderator = 0;
NSString *notes = 0;
NSString *only_private_comments = 0;
NSString *organization_id = 0;
NSString *phone = 0;
BOOL In1f;
BOOL Cillumb5;
NSString *remote_photo_url = 0;
NSString *report_csv = 0;
NSString *restricted_agent = 0;
NSString *role = 0;
NSString *role_type = 0;
NSString *v_shared = 0;
NSString *shared_agent = 0;
NSString *shared_phone_number = 0;
NSString *signature = 0;
NSString *suspended = 0;
NSString *tags = 0;
NSString *ticket_restriction = 0;
NSString *time_zone = 0;
NSString *two_factor_auth_enabled = 0;
NSString *updated_at = 0;
NSString *url = 0;
NSString *Nisi_e = 0;
NSString *verified = 0;
BOOL Ut69;
int Magna_4;
int Loremcc;
BOOL Dolore7;
NSString *Pariaturf = 0;
int i = 0;
int count_i = [[jResp SizeOfArray: @"users"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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"];
In1f = [jResp BoolOf: @"users[i].photo.in1f"];
Cillumb5 = [jResp BoolOf: @"users[i].photo.cillumb5"];
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"];
Nisi_e = [jResp StringOf: @"users[i].user_fields.nisi_e"];
verified = [jResp StringOf: @"users[i].verified"];
Ut69 = [jResp BoolOf: @"users[i].photo.ut69"];
Magna_4 = [[jResp IntOf: @"users[i].photo.magna_4"] intValue];
Loremcc = [[jResp IntOf: @"users[i].user_fields.Loremcc"] intValue];
Dolore7 = [jResp BoolOf: @"users[i].user_fields.dolore7"];
Pariaturf = [jResp StringOf: @"users[i].user_fields.pariaturf"];
i = i + 1;
}
Curl Command
curl -u login:password -G -d "query=%3Cstring%3E"
-d "external_id=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/search
Postman Collection Item JSON
{
"name": "Search Users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/search?query=<string>&external_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "The `query` parameter supports the Zendesk search syntax for more advanced\nuser searches. It can specify a partial or full value of any\nuser property, including name, email address, notes, or phone. Example:\n`query=\"jdoe\"`.\nSee the [Search API](/api-reference/ticketing/ticket-management/search/).\n"
},
{
"key": "external_id",
"value": "<string>",
"description": "The `external_id` parameter does not support the search syntax. It only accepts ids.\n"
}
]
},
"description": "Returns an array of users who meet the search criteria.\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\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/search?query=<string>&external_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "The `query` parameter supports the Zendesk search syntax for more advanced\nuser searches. It can specify a partial or full value of any\nuser property, including name, email address, notes, or phone. Example:\n`query=\"jdoe\"`.\nSee the [Search API](/api-reference/ticketing/ticket-management/search/).\n"
},
{
"key": "external_id",
"value": "<string>",
"description": "The `external_id` parameter does not support the search syntax. It only accepts ids.\n"
}
]
}
},
"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}"
}
]
}
