Unicode C++ / Support API / Autocomplete Users
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); queryParams.UpdateString(L"name",L"<string>"); queryParams.UpdateString(L"field_id",L"<string>"); queryParams.UpdateString(L"source",L"<string>"); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); name = jResp.stringOf(L"users[i].name"); active = jResp.stringOf(L"users[i].active"); alias = jResp.stringOf(L"users[i].alias"); chat_only = jResp.stringOf(L"users[i].chat_only"); created_at = jResp.stringOf(L"users[i].created_at"); custom_role_id = jResp.stringOf(L"users[i].custom_role_id"); default_group_id = jResp.stringOf(L"users[i].default_group_id"); details = jResp.stringOf(L"users[i].details"); email = jResp.stringOf(L"users[i].email"); external_id = jResp.stringOf(L"users[i].external_id"); iana_time_zone = jResp.stringOf(L"users[i].iana_time_zone"); id = jResp.stringOf(L"users[i].id"); last_login_at = jResp.stringOf(L"users[i].last_login_at"); locale = jResp.stringOf(L"users[i].locale"); locale_id = jResp.stringOf(L"users[i].locale_id"); moderator = jResp.stringOf(L"users[i].moderator"); notes = jResp.stringOf(L"users[i].notes"); only_private_comments = jResp.stringOf(L"users[i].only_private_comments"); organization_id = jResp.stringOf(L"users[i].organization_id"); phone = jResp.stringOf(L"users[i].phone"); In1f = jResp.BoolOf(L"users[i].photo.in1f"); Cillumb5 = jResp.BoolOf(L"users[i].photo.cillumb5"); remote_photo_url = jResp.stringOf(L"users[i].remote_photo_url"); report_csv = jResp.stringOf(L"users[i].report_csv"); restricted_agent = jResp.stringOf(L"users[i].restricted_agent"); role = jResp.stringOf(L"users[i].role"); role_type = jResp.stringOf(L"users[i].role_type"); v_shared = jResp.stringOf(L"users[i].shared"); shared_agent = jResp.stringOf(L"users[i].shared_agent"); shared_phone_number = jResp.stringOf(L"users[i].shared_phone_number"); signature = jResp.stringOf(L"users[i].signature"); suspended = jResp.stringOf(L"users[i].suspended"); tags = jResp.stringOf(L"users[i].tags"); ticket_restriction = jResp.stringOf(L"users[i].ticket_restriction"); time_zone = jResp.stringOf(L"users[i].time_zone"); two_factor_auth_enabled = jResp.stringOf(L"users[i].two_factor_auth_enabled"); updated_at = jResp.stringOf(L"users[i].updated_at"); url = jResp.stringOf(L"users[i].url"); Nisi_e = jResp.stringOf(L"users[i].user_fields.nisi_e"); verified = jResp.stringOf(L"users[i].verified"); Ut69 = jResp.BoolOf(L"users[i].photo.ut69"); Magna_4 = jResp.IntOf(L"users[i].photo.magna_4"); Loremcc = jResp.IntOf(L"users[i].user_fields.Loremcc"); Dolore7 = jResp.BoolOf(L"users[i].user_fields.dolore7"); Pariaturf = jResp.stringOf(L"users[i].user_fields.pariaturf"); i = i + 1;
}
Curl Command
curl -u login:password -G -d "name=%3Cstring%3E"
-d "field_id=%3Cstring%3E"
-d "source=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/autocomplete
Postman Collection Item JSON
{
"name": "Autocomplete Users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/autocomplete?name=<string>&field_id=<string>&source=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"autocomplete"
],
"query": [
{
"key": "name",
"value": "<string>",
"description": "(Required) The name to search for the user.\n"
},
{
"key": "field_id",
"value": "<string>",
"description": "The id of a lookup relationship field. The type of field is determined\nby the `source` param\n"
},
{
"key": "source",
"value": "<string>",
"description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
}
]
},
"description": "Returns an array of users whose name starts with the value specified in the `name` parameter.\nIt only returns users with no foreign identities.\n\n#### Allowed For\n\n* 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/autocomplete?name=<string>&field_id=<string>&source=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"autocomplete"
],
"query": [
{
"key": "name",
"value": "<string>",
"description": "(Required) The name to search for the user.\n"
},
{
"key": "field_id",
"value": "<string>",
"description": "The id of a lookup relationship field. The type of field is determined\nby the `source` param\n"
},
{
"key": "source",
"value": "<string>",
"description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\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}"
}
]
}
