autoit / Support API / List User Fields
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/user_fields",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "count": "<integer>",
; "next_page": "<string>",
; "previous_page": "<string>",
; "user_fields": [
; {
; "key": "<string>",
; "type": "<string>",
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "custom_field_options": [
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; },
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; }
; ],
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_description": "<string>",
; "raw_title": "<string>",
; "regexp_for_validation": "<string>",
; "relationship_filter": {},
; "relationship_target_type": "<string>",
; "system": "<boolean>",
; "tag": "<string>",
; "updated_at": "<dateTime>",
; "url": "<string>"
; },
; {
; "key": "<string>",
; "type": "<string>",
; "title": "<string>",
; "active": "<boolean>",
; "created_at": "<dateTime>",
; "custom_field_options": [
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; },
; {
; "name": "<string>",
; "value": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_name": "<string>",
; "url": "<string>"
; }
; ],
; "description": "<string>",
; "id": "<integer>",
; "position": "<integer>",
; "raw_description": "<string>",
; "raw_title": "<string>",
; "regexp_for_validation": "<string>",
; "relationship_filter": {},
; "relationship_target_type": "<string>",
; "system": "<boolean>",
; "tag": "<string>",
; "updated_at": "<dateTime>",
; "url": "<string>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sKey
Local $sV_type
Local $sTitle
Local $sActive
Local $sCreated_at
Local $sDescription
Local $sId
Local $sPosition
Local $sRaw_description
Local $sRaw_title
Local $sRegexp_for_validation
Local $sRelationship_target_type
Local $system
Local $sTag
Local $sUpdated_at
Local $sUrl
Local $iJ
Local $iCount_j
Local $sName
Local $sValue
Local $sRaw_name
Local $sCount = $oJResp.StringOf("count")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $sPrevious_page = $oJResp.StringOf("previous_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("user_fields")
While $i < $iCount_i
$oJResp.I = $i
$sKey = $oJResp.StringOf("user_fields[i].key")
$sV_type = $oJResp.StringOf("user_fields[i].type")
$sTitle = $oJResp.StringOf("user_fields[i].title")
$sActive = $oJResp.StringOf("user_fields[i].active")
$sCreated_at = $oJResp.StringOf("user_fields[i].created_at")
$sDescription = $oJResp.StringOf("user_fields[i].description")
$sId = $oJResp.StringOf("user_fields[i].id")
$sPosition = $oJResp.StringOf("user_fields[i].position")
$sRaw_description = $oJResp.StringOf("user_fields[i].raw_description")
$sRaw_title = $oJResp.StringOf("user_fields[i].raw_title")
$sRegexp_for_validation = $oJResp.StringOf("user_fields[i].regexp_for_validation")
$sRelationship_target_type = $oJResp.StringOf("user_fields[i].relationship_target_type")
$system = $oJResp.StringOf("user_fields[i].system")
$sTag = $oJResp.StringOf("user_fields[i].tag")
$sUpdated_at = $oJResp.StringOf("user_fields[i].updated_at")
$sUrl = $oJResp.StringOf("user_fields[i].url")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("user_fields[i].custom_field_options")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sName = $oJResp.StringOf("user_fields[i].custom_field_options[j].name")
$sValue = $oJResp.StringOf("user_fields[i].custom_field_options[j].value")
$sId = $oJResp.StringOf("user_fields[i].custom_field_options[j].id")
$sPosition = $oJResp.StringOf("user_fields[i].custom_field_options[j].position")
$sRaw_name = $oJResp.StringOf("user_fields[i].custom_field_options[j].raw_name")
$sUrl = $oJResp.StringOf("user_fields[i].custom_field_options[j].url")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/user_fields
Postman Collection Item JSON
{
"name": "List User Fields",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_fields"
]
},
"description": "Returns a list of custom user fields in your account. Fields are returned in the order that you specify in your user fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the `user_fields` attribute on the [User](/api-reference/ticketing/users/users/) resource.\n\n#### 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* 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/user_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_fields"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"user_fields\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
