Foxpro / Support API / List User Fields
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcKey
LOCAL lcV_type
LOCAL lcTitle
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_description
LOCAL lcRaw_title
LOCAL lcRegexp_for_validation
LOCAL lcRelationship_target_type
LOCAL lcSystem
LOCAL lcTag
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL j
LOCAL lnCount_j
LOCAL lcName
LOCAL lcValue
LOCAL lcRaw_name
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/user_fields",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("user_fields")
DO WHILE i < lnCount_i
loJResp.I = i
lcKey = loJResp.StringOf("user_fields[i].key")
lcV_type = loJResp.StringOf("user_fields[i].type")
lcTitle = loJResp.StringOf("user_fields[i].title")
lcActive = loJResp.StringOf("user_fields[i].active")
lcCreated_at = loJResp.StringOf("user_fields[i].created_at")
lcDescription = loJResp.StringOf("user_fields[i].description")
lcId = loJResp.StringOf("user_fields[i].id")
lcPosition = loJResp.StringOf("user_fields[i].position")
lcRaw_description = loJResp.StringOf("user_fields[i].raw_description")
lcRaw_title = loJResp.StringOf("user_fields[i].raw_title")
lcRegexp_for_validation = loJResp.StringOf("user_fields[i].regexp_for_validation")
lcRelationship_target_type = loJResp.StringOf("user_fields[i].relationship_target_type")
lcSystem = loJResp.StringOf("user_fields[i].system")
lcTag = loJResp.StringOf("user_fields[i].tag")
lcUpdated_at = loJResp.StringOf("user_fields[i].updated_at")
lcUrl = loJResp.StringOf("user_fields[i].url")
j = 0
lnCount_j = loJResp.SizeOfArray("user_fields[i].custom_field_options")
DO WHILE j < lnCount_j
loJResp.J = j
lcName = loJResp.StringOf("user_fields[i].custom_field_options[j].name")
lcValue = loJResp.StringOf("user_fields[i].custom_field_options[j].value")
lcId = loJResp.StringOf("user_fields[i].custom_field_options[j].id")
lcPosition = loJResp.StringOf("user_fields[i].custom_field_options[j].position")
lcRaw_name = loJResp.StringOf("user_fields[i].custom_field_options[j].raw_name")
lcUrl = loJResp.StringOf("user_fields[i].custom_field_options[j].url")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
