DataFlex / Support API / Search Users
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sActive
String sAlias
String sChat_only
String sCreated_at
String sCustom_role_id
String sDefault_group_id
String sDetails
String sEmail
String sExternal_id
String sIana_time_zone
String sId
String sLast_login_at
String sLocale
String sLocale_id
String sModerator
String sNotes
String sOnly_private_comments
String sOrganization_id
String sPhone
Boolean iIn1f
Boolean iCillumb5
String sRemote_photo_url
String sReport_csv
String sRestricted_agent
String sRole
String sRole_type
String sV_shared
String sShared_agent
String sShared_phone_number
String sSignature
String sSuspended
String sTags
String sTicket_restriction
String sTime_zone
String sTwo_factor_auth_enabled
String sUpdated_at
String sUrl
String sNisi_e
String sVerified
Boolean iUt69
Integer iMagna_4
Integer iLoremcc
Boolean iDolore7
String sPariaturf
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "query" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "external_id" "<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://example.zendesk.com/api/v2/users/search" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "users" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "users[i].name" To sName
Get ComStringOf Of hoJResp "users[i].active" To sActive
Get ComStringOf Of hoJResp "users[i].alias" To sAlias
Get ComStringOf Of hoJResp "users[i].chat_only" To sChat_only
Get ComStringOf Of hoJResp "users[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "users[i].custom_role_id" To sCustom_role_id
Get ComStringOf Of hoJResp "users[i].default_group_id" To sDefault_group_id
Get ComStringOf Of hoJResp "users[i].details" To sDetails
Get ComStringOf Of hoJResp "users[i].email" To sEmail
Get ComStringOf Of hoJResp "users[i].external_id" To sExternal_id
Get ComStringOf Of hoJResp "users[i].iana_time_zone" To sIana_time_zone
Get ComStringOf Of hoJResp "users[i].id" To sId
Get ComStringOf Of hoJResp "users[i].last_login_at" To sLast_login_at
Get ComStringOf Of hoJResp "users[i].locale" To sLocale
Get ComStringOf Of hoJResp "users[i].locale_id" To sLocale_id
Get ComStringOf Of hoJResp "users[i].moderator" To sModerator
Get ComStringOf Of hoJResp "users[i].notes" To sNotes
Get ComStringOf Of hoJResp "users[i].only_private_comments" To sOnly_private_comments
Get ComStringOf Of hoJResp "users[i].organization_id" To sOrganization_id
Get ComStringOf Of hoJResp "users[i].phone" To sPhone
Get ComBoolOf Of hoJResp "users[i].photo.in1f" To iIn1f
Get ComBoolOf Of hoJResp "users[i].photo.cillumb5" To iCillumb5
Get ComStringOf Of hoJResp "users[i].remote_photo_url" To sRemote_photo_url
Get ComStringOf Of hoJResp "users[i].report_csv" To sReport_csv
Get ComStringOf Of hoJResp "users[i].restricted_agent" To sRestricted_agent
Get ComStringOf Of hoJResp "users[i].role" To sRole
Get ComStringOf Of hoJResp "users[i].role_type" To sRole_type
Get ComStringOf Of hoJResp "users[i].shared" To sV_shared
Get ComStringOf Of hoJResp "users[i].shared_agent" To sShared_agent
Get ComStringOf Of hoJResp "users[i].shared_phone_number" To sShared_phone_number
Get ComStringOf Of hoJResp "users[i].signature" To sSignature
Get ComStringOf Of hoJResp "users[i].suspended" To sSuspended
Get ComStringOf Of hoJResp "users[i].tags" To sTags
Get ComStringOf Of hoJResp "users[i].ticket_restriction" To sTicket_restriction
Get ComStringOf Of hoJResp "users[i].time_zone" To sTime_zone
Get ComStringOf Of hoJResp "users[i].two_factor_auth_enabled" To sTwo_factor_auth_enabled
Get ComStringOf Of hoJResp "users[i].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "users[i].url" To sUrl
Get ComStringOf Of hoJResp "users[i].user_fields.nisi_e" To sNisi_e
Get ComStringOf Of hoJResp "users[i].verified" To sVerified
Get ComBoolOf Of hoJResp "users[i].photo.ut69" To iUt69
Get ComIntOf Of hoJResp "users[i].photo.magna_4" To iMagna_4
Get ComIntOf Of hoJResp "users[i].user_fields.Loremcc" To iLoremcc
Get ComBoolOf Of hoJResp "users[i].user_fields.dolore7" To iDolore7
Get ComStringOf Of hoJResp "users[i].user_fields.pariaturf" To sPariaturf
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
