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

contacts: Freshdesk Contacts

Catalog: Freshdesk

Schema: Freshdesk

Primary Keys: id

Label: Contacts

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 contacts. 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
_updated_since	datetime	☐	01/01/1900 00:00:00	Limit to contacts updated since.
company_id	int64	☐		Company ID of contact.
email	varchar2	☐		Email address of the contact.
mobile	varchar2	☐		Mobile number of the contact.
phone	varchar2	☐		Phone of the contact.
query	varchar2	☐		Custom query matching Freshdesk specifications, such as 'active:true'.
state	varchar2	☐		Pre-defined filter: 'blocked', 'deleted', 'unverified' and 'verified'.

Columns of Table Function

The columns of the table function contacts 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
active	char	Active	☐	Whether the user has been verified.
address	varchar2	Address	☐	Address of the user.
company_id	int64	Company ID	☐
created_at	datetime	Created at	☐	Date/time at which the record was created.
customer_id	int64	Customer ID	☐	ID of the company to which this user belongs.
deleted	char	Deleted	☐	Whether the contact has been deleted.
description	varchar2	Description	☐	A short description about the user.
email	varchar2	Email	☐	Primary email for the user.
external_id	int64	External ID	☐	Internal usage.
helpdesk_agent	char	Helpdesk Agent	☐	Whether the user is an agent.
id	int64	ID	☑	ID of the user.
job_title	varchar2	Job Title	☐	Job title of the user.
language	varchar2	Language	☐	Language of the user. Default language is 'en' for English.
mobile	varchar2	Mobile	☐	Mobile number of the user.
name	varchar2	Name	☐	Name of the user.
phone	varchar2	Phone	☐	Phone number of the user.
time_zone	varchar2	Time Zone	☐	Time zone of the user.
twitter_id	varchar2	Twitter ID	☐	Twitter ID of the user.
unique_external_id	varchar2	Unique External ID	☐	External ID of the user.
updated_at	datetime	Updated at	☐	Date/time at which the record was last updated.
view_all_tickets	char	View All Tickets	☐	Whether the contact can see all tickets that are associated with the company to which the contact belongs.

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

contacts: Freshdesk Contacts

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information