Skip to main content

Zendesk

Read-only tool types over Zendesk Support tickets: fetch one ticket by ID, search with Zendesk's query syntax, or list tickets in a date range.

Every type on this page requires a Zendesk connector; connectorId is the ID of that connector. Ticket IDs are Zendesk's own numeric IDs — the ones agents and customers see in the Zendesk UI and email subjects.

Get ticket TOOLZENDESK_GET_TICKET​

Fetches a single ticket by its numeric ID, returning subject, description, status, priority, requester and assignee, tags, and timestamps. Use it when the agent already has a ticket number — from a customer message, a search result, or a webhook.

Example​

Tool config
{
  "toolType": "ZENDESK_GET_TICKET",
  "connectorId": "V1StGXR8Z5",
  "ticketId": "@@{ticketId}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    ticketId
    Type
    integer
    Description
    Required integer value.

Search tickets TOOLZENDESK_SEARCH_TICKETS​

Searches tickets with Zendesk's full search query syntax — free text plus operators like status:open, priority:high, requester:jane@example.com, or tags:billing. Results can be sorted by updated_at, created_at, priority, or status, in either direction, and capped with limit (default 25, max 100). This is the most flexible of the three tools; reach for it whenever the criteria are anything other than "a date range".

Example​

Tool config
{
  "toolType": "ZENDESK_SEARCH_TICKETS",
  "connectorId": "V1StGXR8Z5",
  "query": "@@{searchQuery}",
  "sortBy": "updated_at",
  "sortOrder": "desc",
  "limit": 25
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    query
    Type
    string
    Description
    Zendesk search query string (required)
  • Name
    sortBy
    Type
    string · optional
    Description
    Optional: "updated_at", "created_at", "priority", "status"
  • Name
    sortOrder
    Type
    string · optional
    Description
    Optional: "asc" or "desc"
  • Name
    limit
    Type
    integer · optional
    Description
    Optional: number of results (default 25, max 100)

List tickets TOOLZENDESK_LIST_TICKETS​

Lists tickets created or updated within a date range — startDate and endDate in YYYY-MM-DD, with dateField choosing created (default) or updated. The bounds are exclusive, so widen the range by a day on each side to include the endpoints. An optional status filter narrows to one lifecycle state, and results paginate internally up to limit (default 100, max 1000). Under the hood this builds a Zendesk search query, so it shares the Search API's behavior and rate limits.

Example​

Tool config
{
  "toolType": "ZENDESK_LIST_TICKETS",
  "connectorId": "V1StGXR8Z5",
  "startDate": "2026-06-01",
  "endDate": "2026-07-01",
  "dateField": "created",
  "status": "open",
  "limit": 200
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    startDate
    Type
    string
    Description
    Required: YYYY-MM-DD format
  • Name
    endDate
    Type
    string
    Description
    Required: YYYY-MM-DD format
  • Name
    dateField
    Type
    string · optional
    Description
    Optional: "created" or "updated" (default "created")
  • Name
    status
    Type
    string · optional
    Description
    Optional: "new", "open", "pending", "hold", "solved", "closed"
  • Name
    sortBy
    Type
    string · optional
    Description
    Optional: "updated_at", "created_at", "priority", "status"
  • Name
    sortOrder
    Type
    string · optional
    Description
    Optional: "asc" or "desc"
  • Name
    limit
    Type
    integer · optional
    Description
    Optional: number of results (default 100, max 1000)