Please enable JavaScript to view this site.

Navigation: 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.

Select Freshdesk API URL: /contacts

Insert Freshdesk API URL: /contacts

Update Freshdesk API URL: /contacts

Delete Freshdesk API URL: /contacts

Field Selection Method: NotRequired

Table Function Parameters

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 treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `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

string

 

Email address of the contact.

mobile

string

 

Mobile number of the contact.

phone

string

 

Phone of the contact.

query

string

 

Custom query matching Freshdesk specifications, such as 'active:true'.

state

string

 

Pre-defined filter: 'blocked', 'deleted', 'unverified' and 'verified'.

 

Table Function Columns

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 or update.

Name

Data Type

Label

Required

Documentation

active

boolean

Active

Whether the user has been verified.

address

string

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

 

ID of the company to which this user belongs.

deleted

boolean

Deleted

Whether the contact has been deleted.

description

string

Description

A short description about the user.

email

string

Email

Primary email for the user.

external_id

int64

 

Internal usage.

helpdesk_agent

boolean

 

Whether the user is an agent.

id

int64

ID

ID of the user.

job_title

string

Job Title

Job title of the user.

language

string

Language

Language of the user. Default language is 'en' for English.

mobile

string

Mobile

Mobile number of the user.

name

string

Name

Name of the user.

phone

string

Phone

Phone number of the user.

time_zone

string

Time Zone

Time zone of the user.

twitter_id

string

Twitter ID

Twitter ID of the user.

unique_external_id

string

 

External ID of the user.

updated_at

datetime

Updated at

Date/time at which the record was last updated.

view_all_tickets

boolean

View All Tickets

Whether the contact can see all tickets that are associated with the company to which the contact belongs.

 

27-12-2021 10:23 Version 20.2.169-PROD+3633