Search Tickets

Search Tickets

curl --request POST \
  --url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#ZENDESK_SEARCH_TICKETS' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "ZENDESK_SEARCH_TICKETS",
  "parameters": {
    "ticketSubject": "<string>",
    "ticketDescription": "<string>",
    "ticketStatus": "new",
    "ticketType": "problem",
    "createdDate-left": "EQUALS",
    "createdDate-right": "<string>",
    "updatedDate-left": "EQUALS",
    "updatedDate-right": "<string>",
    "dueDate-left": "EQUALS",
    "dueDate-right": "<string>",
    "requesterId": "<string>",
    "assigneeId": "<string>",
    "recipientEmail": "<string>",
    "ticketPriority": "urgent",
    "ticketTags": "<string>",
    "ticketExternalId": "<string>",
    "sort_by": "created_at",
    "sort_order": "asc",
    "dueDate": {
      "operator": "EQUALS",
      "value": "2023-12-25"
    },
    "createdDate": {
      "operator": "EQUALS",
      "value": "2023-12-25"
    },
    "updatedDate": {
      "operator": "EQUALS",
      "value": "2023-12-25"
    }
  }
}
'

POST

projects

{project_id}

actions

#ZENDESK_SEARCH_TICKETS

Search Tickets

curl --request POST \
  --url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#ZENDESK_SEARCH_TICKETS' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "ZENDESK_SEARCH_TICKETS",
  "parameters": {
    "ticketSubject": "<string>",
    "ticketDescription": "<string>",
    "ticketStatus": "new",
    "ticketType": "problem",
    "createdDate-left": "EQUALS",
    "createdDate-right": "<string>",
    "updatedDate-left": "EQUALS",
    "updatedDate-right": "<string>",
    "dueDate-left": "EQUALS",
    "dueDate-right": "<string>",
    "requesterId": "<string>",
    "assigneeId": "<string>",
    "recipientEmail": "<string>",
    "ticketPriority": "urgent",
    "ticketTags": "<string>",
    "ticketExternalId": "<string>",
    "sort_by": "created_at",
    "sort_order": "asc",
    "dueDate": {
      "operator": "EQUALS",
      "value": "2023-12-25"
    },
    "createdDate": {
      "operator": "EQUALS",
      "value": "2023-12-25"
    },
    "updatedDate": {
      "operator": "EQUALS",
      "value": "2023-12-25"
    }
  }
}
'

Authorizations

Authorization

string

header

required

Your Paragon User Token (JWT), which you can generate using your project's signing keys.

Path Parameters

project_id

string

required

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

action

string

default:ZENDESK_SEARCH_TICKETS

required

parameters

object

required

Show child attributes

parameters.ticketSubject

string

Subject : Filter results by the text in the ticket’s subject.

parameters.ticketDescription

string

Description : Filter results by the text in the ticket's description and comments.

parameters.ticketStatus

enum<string>

Status

Available options:

new,

open,

pending,

hold,

solved,

closed

parameters.ticketType

enum<string>

Type

Available options:

problem,

incident,

question,

task,

no_type

parameters.createdDate-left

enum<string>

Created Date : Filter tickets by their created date. (example: "YYYY-MM-DD")

Available options:

EQUALS,

LESS_THAN_EQUALS,

GREATER_THAN_EQUALS

parameters.createdDate-right

string

Created Date Value : Filter tickets by their created date. (example: "YYYY-MM-DD")

parameters.updatedDate-left

enum<string>

Updated Date : Filter tickets by their updated date. (example: "YYYY-MM-DD")

Available options:

EQUALS,

LESS_THAN_EQUALS,

GREATER_THAN_EQUALS

parameters.updatedDate-right

string

Updated Date Value : Filter tickets by their updated date. (example: "YYYY-MM-DD")

parameters.dueDate-left

enum<string>

Due Date : Filter tickets by their due date. (example: "YYYY-MM-DD")

Available options:

EQUALS,

LESS_THAN_EQUALS,

GREATER_THAN_EQUALS

parameters.dueDate-right

string

Due Date Value : Filter tickets by their due date. (example: "YYYY-MM-DD")

parameters.requesterId

string

Requester ID : Filter by the user who requested this ticket.

parameters.assigneeId

string

Assignee ID : Filter by the agent assigned to the ticket.

parameters.recipientEmail

string

Recipient : Filter by the original recipient e-mail address of the ticket. (example: "[email protected]")

parameters.ticketPriority

enum<string>

Priority

Available options:

urgent,

high,

normal,

low,

no_priority

parameters.ticketTags

string

Tags : Filter tickets by their tag.

parameters.ticketExternalId

string

External ID : Filter by tickets by their external ID.

parameters.sort_by

enum<string>

Sort By

Available options:

created_at,

updated_at,

priority,

status,

ticket_type

parameters.sort_order

enum<string>

Sort Order

Available options:

asc,

desc

parameters.dueDate

object

Due Date

Show child attributes

parameters.dueDate.operator

enum<string>

required

Due Date Operator

Available options:

EQUALS,

LESS_THAN_EQUALS,

GREATER_THAN_EQUALS

parameters.dueDate.value

string<date>

required

Due Date Value

parameters.createdDate

object

Created Date

Show child attributes

parameters.createdDate.operator

enum<string>

required

Created Date Operator

Available options:

EQUALS,

LESS_THAN_EQUALS,

GREATER_THAN_EQUALS

parameters.createdDate.value

string<date>

required

Created Date Value

parameters.updatedDate

object

Updated Date

Show child attributes

parameters.updatedDate.operator

enum<string>

required

Updated Date operator

Available options:

EQUALS,

LESS_THAN_EQUALS,

GREATER_THAN_EQUALS

parameters.updatedDate.value

string<date>

required

Updated Date value

Response

200

Success

Add Comment To Ticket Get Ticket By ID

⌘I

ActionKit

API Reference

For AI Agents

Actions Reference

Authorizations

Path Parameters

Body

Response