List ticket fields with the Freshdesk API

Lists the ticket fields of the helpdesk with their choices: agent ids in the agent field, group ids in the group field, product ids, status values including custom ones, ticket types, and the name of each custom field, which is its key in custom_fields. required_for_agents and required_for_closure mark the fields create, update and closing need.

Identifier
freshdesk_list_ticket_fields

The request

POST https://connect.reportei.com/api/tools/freshdesk_list_ticket_fields/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "type": "<type>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
typestringNoOnly fields of this type, for example default_agent, default_group, default_status, default_ticket_type or custom_dropdown.

Supported connections

Your customer connects their Freshdesk account once, with one of the modes below. The same connection serves every tool of the toolkit.

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

When connecting, your customer also enters {domain}: the address of their account on the app's API.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/freshdesk_list_ticket_fields. It becomes your agent's tool definition with no conversion.

Other Freshdesk tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.