Python / Support API / List Organization Fields
Back to Collection Items
import sys
import chilkat
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("password")
http.SetRequestHeader("Accept","application/json")
sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/organization_fields",sbResponseBody)
if (success == False):
print(http.lastErrorText())
sys.exit()
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = http.get_LastStatus()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(http.lastHeader())
print("Failed.")
sys.exit()
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "count": "<integer>",
# "next_page": "<string>",
# "organization_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>"
# }
# ],
# "previous_page": "<string>"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
count = jResp.stringOf("count")
next_page = jResp.stringOf("next_page")
previous_page = jResp.stringOf("previous_page")
i = 0
count_i = jResp.SizeOfArray("organization_fields")
while i < count_i :
jResp.put_I(i)
key = jResp.stringOf("organization_fields[i].key")
v_type = jResp.stringOf("organization_fields[i].type")
title = jResp.stringOf("organization_fields[i].title")
active = jResp.stringOf("organization_fields[i].active")
created_at = jResp.stringOf("organization_fields[i].created_at")
description = jResp.stringOf("organization_fields[i].description")
id = jResp.stringOf("organization_fields[i].id")
position = jResp.stringOf("organization_fields[i].position")
raw_description = jResp.stringOf("organization_fields[i].raw_description")
raw_title = jResp.stringOf("organization_fields[i].raw_title")
regexp_for_validation = jResp.stringOf("organization_fields[i].regexp_for_validation")
relationship_target_type = jResp.stringOf("organization_fields[i].relationship_target_type")
system = jResp.stringOf("organization_fields[i].system")
tag = jResp.stringOf("organization_fields[i].tag")
updated_at = jResp.stringOf("organization_fields[i].updated_at")
url = jResp.stringOf("organization_fields[i].url")
j = 0
count_j = jResp.SizeOfArray("organization_fields[i].custom_field_options")
while j < count_j :
jResp.put_J(j)
name = jResp.stringOf("organization_fields[i].custom_field_options[j].name")
value = jResp.stringOf("organization_fields[i].custom_field_options[j].value")
id = jResp.stringOf("organization_fields[i].custom_field_options[j].id")
position = jResp.stringOf("organization_fields[i].custom_field_options[j].position")
raw_name = jResp.stringOf("organization_fields[i].custom_field_options[j].raw_name")
url = jResp.stringOf("organization_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/organization_fields
Postman Collection Item JSON
{
"name": "List Organization Fields",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/organization_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_fields"
]
},
"description": "Returns a list of custom organization fields in your account. Fields are returned in the order that you specify in your organization fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each organization field to the values returned under the `organization_fields` attribute on the [organization](/api-reference/ticketing/organizations/organizations/) 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/organization_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"organization_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 \"organization_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 \"previous_page\": \"<string>\"\n}"
}
]
}
