Chilkat Online Tools

Swift / Support API / List User Fields

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    http.BasicAuth = true
    http.Login = "login"
    http.Password = "password"

    http.SetRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/user_fields", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // 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

    var key: String?
    var v_type: String?
    var title: String?
    var active: String?
    var created_at: String?
    var description: String?
    var id: String?
    var position: String?
    var raw_description: String?
    var raw_title: String?
    var regexp_for_validation: String?
    var relationship_target_type: String?
    var system: String?
    var tag: String?
    var updated_at: String?
    var url: String?
    var j: Int
    var count_j: Int
    var name: String?
    var value: String?
    var raw_name: String?

    var count: String? = jResp.StringOf("count")
    var next_page: String? = jResp.StringOf("next_page")
    var previous_page: String? = jResp.StringOf("previous_page")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("user_fields").intValue
    while i < count_i {
        jResp.I = i
        key = jResp.StringOf("user_fields[i].key")
        v_type = jResp.StringOf("user_fields[i].type")
        title = jResp.StringOf("user_fields[i].title")
        active = jResp.StringOf("user_fields[i].active")
        created_at = jResp.StringOf("user_fields[i].created_at")
        description = jResp.StringOf("user_fields[i].description")
        id = jResp.StringOf("user_fields[i].id")
        position = jResp.StringOf("user_fields[i].position")
        raw_description = jResp.StringOf("user_fields[i].raw_description")
        raw_title = jResp.StringOf("user_fields[i].raw_title")
        regexp_for_validation = jResp.StringOf("user_fields[i].regexp_for_validation")
        relationship_target_type = jResp.StringOf("user_fields[i].relationship_target_type")
        system = jResp.StringOf("user_fields[i].system")
        tag = jResp.StringOf("user_fields[i].tag")
        updated_at = jResp.StringOf("user_fields[i].updated_at")
        url = jResp.StringOf("user_fields[i].url")
        j = 0
        count_j = jResp.SizeOfArray("user_fields[i].custom_field_options").intValue
        while j < count_j {
            jResp.J = j
            name = jResp.StringOf("user_fields[i].custom_field_options[j].name")
            value = jResp.StringOf("user_fields[i].custom_field_options[j].value")
            id = jResp.StringOf("user_fields[i].custom_field_options[j].id")
            position = jResp.StringOf("user_fields[i].custom_field_options[j].position")
            raw_name = jResp.StringOf("user_fields[i].custom_field_options[j].raw_name")
            url = jResp.StringOf("user_fields[i].custom_field_options[j].url")
            j = j + 1
        }

        i = i + 1
    }


}

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}"
    }
  ]
}