Delphi (ActiveX) / Support API / List Users
Back to Collection Items
var
begin
http.BasicAuth := 1;http.Login := 'login';http.Password := 'password';queryParams.UpdateString('role','end-user');queryParams.UpdateString('role[]','<string>');queryParams.UpdateString('permission_set','<integer>');queryParams.UpdateString('external_id','<string>');resp.GetBodySb(sbResponseBody.ControlInterface);jResp.LoadSb(sbResponseBody.ControlInterface);jResp.EmitCompact := 0;jResp.I := 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');Loremcc := jResp.IntOf('users[i].user_fields.Loremcc');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 "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}"
}
]
}
