Navigation: Catalog: Freshdesk > Schemas > Schema: Freshdesk > Tables

search_tickets: Freshdesk Search Tickets

Catalog: Freshdesk

Schema: Freshdesk

Primary Keys: id

Label: Search Tickets

Documentation:

Search for tickets using a query.

Can retrieve data and change data using insert, update and delete.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function search_tickets. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Default Value	Documentation
query	varchar2	☑		Custom query matching Freshdesk specifications, such as '(priority:3 OR priority:2) AND created_at:>'2022-01-01''. The following fields can be used in the query: agent_id, group_id, priority, status, tag, type, due_by, fr_due_by, created_at and updated_at.

Columns of Table Function

The columns of the table function search_tickets are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name	Data Type	Label	Required	Documentation
associated_tickets_count	int64	Associated Tickets Count	☐
cf_reference_number	decimal	Reference Number	☐	Custom field #10000152167 of type custom_number.
company_id	int64	Company ID	☐
created_at	datetime	Created at	☐	Date/time at which the record was created.
deleted	char	Deleted	☐	Set as true if the ticket is deleted/trashed. Deleted tickets will not be considered in any views except 'deleted' filter.
description_html	varchar2	Description (HTML)	☐	HTML content of the ticket. Description and description_html should not be passed together.
description_text	varchar2	Description	☐	Plain text content of the ticket.
description	varchar2	Description	☐
due_by	datetime	Due by	☐	Ticket due-by time.
email_config_id	int64	Email Configuration ID	☐	ID of email config which is used for this ticket.
email	varchar2	Email	☐	Email address of the requester. If no contact exists with this email address in Freshdesk, it will be added as a new contact.
facebook_id	varchar2	Facebook ID	☐	Facebook ID of the requester. A contact should exist with this facebook_id in Freshdesk.
fr_due_by	datetime	From Due by	☐	Timestamp that denotes when the first response is due.
fr_escalated	char	From Escalated	☐	Set to true if the ticket has been escalated as the result of first response time being breached.
group_id	int64	Group ID	☐	ID of Group to which the ticket is assigned.
id	int64	ID	☑	Unique ID of the ticket.
internal_agent_id	int64	Internal Agent ID	☐
internal_group_id	int64	Internal Group ID	☐
is_escalated	char	Is Escalated	☐	Set to true if an escalation was sent.
name	varchar2	Name	☐	Name of the requester.
nr_due_by	datetime	Due by (NR)	☐
nr_escalated	char	Escalated (NR)	☐
phone	varchar2	Phone	☐	Phone number of the requester. If no contact exists with this phone number in Freshdesk, it will be added as a new contact. If the phone number is set and the email address is not, then the name attribute is mandatory.
priority	int16	Priority	☐	Priority of the ticket.
product_id	int64	Product ID	☐	ID of the product to which the ticket is associated.
requester_id	varchar2	Requester ID	☐	User-id of the requester. For existing contacts, requester_id can be passed instead of email.
responder_id	int64	Responder ID	☐	ID of the agent to whom the ticket is assigned.
source	int16	Source	☐	The channel through which the ticket was created.
spam	char	Spam	☐	Set as true if the ticket is marked as spam.
status	int16	Status	☐	Status of the ticket.
subject	varchar2	Subject	☐	Ticket subject.
ticket_type	varchar2	Ticket Type	☐	Type property field as defined in ticket fields.
to_emails	varchar2	To Emails	☐
twitter_id	varchar2	Twitter ID	☐	Twitter handle of the requester. If no contact exists with this handle in Freshdesk, it will be added as a new contact.
type	varchar2	Type	☐	Helps categorize the ticket according to the different kinds of issues your support team deals with.
updated_at	datetime	Updated at	☐	Date/time at which the record was last updated.

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Freshdesk API Data Model

search_tickets: Freshdesk Search Tickets

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information