Unicode C++ / Support API / List User Fields
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/user_fields",sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); key = jResp.stringOf(L"user_fields[i].key"); v_type = jResp.stringOf(L"user_fields[i].type"); title = jResp.stringOf(L"user_fields[i].title"); active = jResp.stringOf(L"user_fields[i].active"); created_at = jResp.stringOf(L"user_fields[i].created_at"); description = jResp.stringOf(L"user_fields[i].description"); id = jResp.stringOf(L"user_fields[i].id"); position = jResp.stringOf(L"user_fields[i].position"); raw_description = jResp.stringOf(L"user_fields[i].raw_description"); raw_title = jResp.stringOf(L"user_fields[i].raw_title"); regexp_for_validation = jResp.stringOf(L"user_fields[i].regexp_for_validation"); relationship_target_type = jResp.stringOf(L"user_fields[i].relationship_target_type"); system = jResp.stringOf(L"user_fields[i].system"); tag = jResp.stringOf(L"user_fields[i].tag"); updated_at = jResp.stringOf(L"user_fields[i].updated_at"); url = jResp.stringOf(L"user_fields[i].url"); j = 0; count_j = jResp.SizeOfArray(L"user_fields[i].custom_field_options"); jResp.put_J(j); name = jResp.stringOf(L"user_fields[i].custom_field_options[j].name"); value = jResp.stringOf(L"user_fields[i].custom_field_options[j].value"); id = jResp.stringOf(L"user_fields[i].custom_field_options[j].id"); position = jResp.stringOf(L"user_fields[i].custom_field_options[j].position"); raw_name = jResp.stringOf(L"user_fields[i].custom_field_options[j].raw_name"); url = jResp.stringOf(L"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}"
}
]
}