Get Ticket Fields
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "ZENDESK_GET_TICKET_FIELDS",
"parameters": {
"paginationParameters": {
"pageCursor": "<string>",
"limit": 123
}
}
}
'import requests
url = "https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS"
payload = {
"tool": "ZENDESK_GET_TICKET_FIELDS",
"parameters": { "paginationParameters": {
"pageCursor": "<string>",
"limit": 123
} }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tool: 'ZENDESK_GET_TICKET_FIELDS',
parameters: {paginationParameters: {pageCursor: '<string>', limit: 123}}
})
};
fetch('https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool' => 'ZENDESK_GET_TICKET_FIELDS',
'parameters' => [
'paginationParameters' => [
'pageCursor' => '<string>',
'limit' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS"
payload := strings.NewReader("{\n \"tool\": \"ZENDESK_GET_TICKET_FIELDS\",\n \"parameters\": {\n \"paginationParameters\": {\n \"pageCursor\": \"<string>\",\n \"limit\": 123\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tool\": \"ZENDESK_GET_TICKET_FIELDS\",\n \"parameters\": {\n \"paginationParameters\": {\n \"pageCursor\": \"<string>\",\n \"limit\": 123\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool\": \"ZENDESK_GET_TICKET_FIELDS\",\n \"parameters\": {\n \"paginationParameters\": {\n \"pageCursor\": \"<string>\",\n \"limit\": 123\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"records": [
{
"url": "https://example.zendesk.com/api/v2/ticket_fields/360000800278.json",
"id": 360000800278,
"type": "subject",
"title": "Subject",
"raw_title": "Subject",
"description": "",
"raw_description": "",
"position": 0,
"active": true,
"required": false,
"collapsed_for_agents": false,
"regexp_for_validation": null,
"title_in_portal": "Subject",
"raw_title_in_portal": "Subject",
"visible_in_portal": true,
"editable_in_portal": true,
"required_in_portal": true,
"agent_can_edit": true,
"tag": null,
"created_at": "2020-11-10T09:24:07Z",
"updated_at": "2026-07-16T10:59:12Z",
"removable": false,
"key": null,
"agent_description": null,
"raw_agent_description": null
},
{
"url": "https://example.zendesk.com/api/v2/ticket_fields/360000820298.json",
"id": 360000820298,
"type": "description",
"title": "Description",
"raw_title": "Description",
"description": "Please enter the details of your request. A member of our support staff will respond as soon as possible.",
"raw_description": "Please enter the details of your request. A member of our support staff will respond as soon as possible.",
"position": 1,
"active": true,
"required": false,
"collapsed_for_agents": false,
"regexp_for_validation": null,
"title_in_portal": "Description",
"raw_title_in_portal": "Description",
"visible_in_portal": true,
"editable_in_portal": true,
"required_in_portal": true,
"agent_can_edit": true,
"tag": null,
"created_at": "2020-11-10T09:24:08Z",
"updated_at": "2026-07-16T10:59:12Z",
"removable": false,
"key": null,
"agent_description": null,
"raw_agent_description": null
},
{
"url": "https://example.zendesk.com/api/v2/ticket_fields/360000840318.json",
"id": 360000840318,
"type": "status",
"title": "Status",
"raw_title": "Status",
"description": "Request status",
"raw_description": "Request status",
"position": 3,
"active": true,
"required": false,
"collapsed_for_agents": false,
"regexp_for_validation": null,
"title_in_portal": "Status",
"raw_title_in_portal": "Status",
"visible_in_portal": false,
"editable_in_portal": false,
"required_in_portal": false,
"agent_can_edit": true,
"tag": null,
"created_at": "2020-11-10T09:24:08Z",
"updated_at": "2020-11-10T09:24:08Z",
"removable": false,
"key": null,
"agent_description": null,
"raw_agent_description": null,
"system_field_options": [
{
"name": "Open",
"value": "open"
},
{
"name": "Pending",
"value": "pending"
},
{
"name": "Solved",
"value": "solved"
}
],
"sub_type_id": 0
}
],
"nextPageCursor": null
}Tools
Get Ticket Fields
POST
/
projects
/
{project_id}
/
tools
/
#ZENDESK_GET_TICKET_FIELDS
Get Ticket Fields
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "ZENDESK_GET_TICKET_FIELDS",
"parameters": {
"paginationParameters": {
"pageCursor": "<string>",
"limit": 123
}
}
}
'import requests
url = "https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS"
payload = {
"tool": "ZENDESK_GET_TICKET_FIELDS",
"parameters": { "paginationParameters": {
"pageCursor": "<string>",
"limit": 123
} }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tool: 'ZENDESK_GET_TICKET_FIELDS',
parameters: {paginationParameters: {pageCursor: '<string>', limit: 123}}
})
};
fetch('https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool' => 'ZENDESK_GET_TICKET_FIELDS',
'parameters' => [
'paginationParameters' => [
'pageCursor' => '<string>',
'limit' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS"
payload := strings.NewReader("{\n \"tool\": \"ZENDESK_GET_TICKET_FIELDS\",\n \"parameters\": {\n \"paginationParameters\": {\n \"pageCursor\": \"<string>\",\n \"limit\": 123\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tool\": \"ZENDESK_GET_TICKET_FIELDS\",\n \"parameters\": {\n \"paginationParameters\": {\n \"pageCursor\": \"<string>\",\n \"limit\": 123\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://actionkit.useparagon.com/projects/{project_id}/tools/#ZENDESK_GET_TICKET_FIELDS")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool\": \"ZENDESK_GET_TICKET_FIELDS\",\n \"parameters\": {\n \"paginationParameters\": {\n \"pageCursor\": \"<string>\",\n \"limit\": 123\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"records": [
{
"url": "https://example.zendesk.com/api/v2/ticket_fields/360000800278.json",
"id": 360000800278,
"type": "subject",
"title": "Subject",
"raw_title": "Subject",
"description": "",
"raw_description": "",
"position": 0,
"active": true,
"required": false,
"collapsed_for_agents": false,
"regexp_for_validation": null,
"title_in_portal": "Subject",
"raw_title_in_portal": "Subject",
"visible_in_portal": true,
"editable_in_portal": true,
"required_in_portal": true,
"agent_can_edit": true,
"tag": null,
"created_at": "2020-11-10T09:24:07Z",
"updated_at": "2026-07-16T10:59:12Z",
"removable": false,
"key": null,
"agent_description": null,
"raw_agent_description": null
},
{
"url": "https://example.zendesk.com/api/v2/ticket_fields/360000820298.json",
"id": 360000820298,
"type": "description",
"title": "Description",
"raw_title": "Description",
"description": "Please enter the details of your request. A member of our support staff will respond as soon as possible.",
"raw_description": "Please enter the details of your request. A member of our support staff will respond as soon as possible.",
"position": 1,
"active": true,
"required": false,
"collapsed_for_agents": false,
"regexp_for_validation": null,
"title_in_portal": "Description",
"raw_title_in_portal": "Description",
"visible_in_portal": true,
"editable_in_portal": true,
"required_in_portal": true,
"agent_can_edit": true,
"tag": null,
"created_at": "2020-11-10T09:24:08Z",
"updated_at": "2026-07-16T10:59:12Z",
"removable": false,
"key": null,
"agent_description": null,
"raw_agent_description": null
},
{
"url": "https://example.zendesk.com/api/v2/ticket_fields/360000840318.json",
"id": 360000840318,
"type": "status",
"title": "Status",
"raw_title": "Status",
"description": "Request status",
"raw_description": "Request status",
"position": 3,
"active": true,
"required": false,
"collapsed_for_agents": false,
"regexp_for_validation": null,
"title_in_portal": "Status",
"raw_title_in_portal": "Status",
"visible_in_portal": false,
"editable_in_portal": false,
"required_in_portal": false,
"agent_can_edit": true,
"tag": null,
"created_at": "2020-11-10T09:24:08Z",
"updated_at": "2020-11-10T09:24:08Z",
"removable": false,
"key": null,
"agent_description": null,
"raw_agent_description": null,
"system_field_options": [
{
"name": "Open",
"value": "open"
},
{
"name": "Pending",
"value": "pending"
},
{
"name": "Solved",
"value": "solved"
}
],
"sub_type_id": 0
}
],
"nextPageCursor": null
}Provider API: Zendesk Support API (v2).
Authorizations
Your Paragon User Token (JWT), which you can generate using your project's signing keys.
Path Parameters
Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.
Body
application/json
Response
200 - application/json
A page of the ticket fields in the account, including any custom fields. nextPageCursor is the Zendesk after_cursor when more results are available and null on the last page. Pass it as paginationParameters.pageCursor to load the next page.
Was this page helpful?