Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Freshdesk API Data Model

Navigation: Schema: Freshdesk > Tables

contact_by_id: Freshdesk Contact

Contents Previous Home Next More

Catalog: Freshdesk

Schema: Freshdesk

Primary Keys: id

Label: Contact

This is a read-only table function. The Freshdesk API may not support changing the data or the Invantive SQL driver for Freshdesk does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Freshdesk API.

Select Freshdesk API URL: /contacts/{id}

Insert Freshdesk API URL: /contacts/{id}

Update Freshdesk API URL: /contacts/{id}

Delete Freshdesk API URL: /contacts/{id}

Field Selection Method: NotRequired

Table Function Parameters

The following parameters can be used to control the behaviour of the table function contact_by_id. 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

id

decimal

 

 

 

Table Function Columns

The columns of the table function contact_by_id are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

active

boolean

Active

 

address

string

Address

 

avatar_avatar_url

string

Avatar (URL)

 

avatar_content_type

string

Avatar Content Type

 

avatar_created_at

datetime

Avatar Created at

 

avatar_id

int64

Avatar ID

 

avatar_name

string

Avatar Name

 

avatar_size

int64

Avatar Size

 

avatar_updated_at

datetime

Avatar Updated at

 

company_id

int64

Company ID

 

created_at

datetime

Created at

 

deleted

string

Deleted

 

description

string

Description

 

email

string

Email

 

id

int64

ID

 

job_title

string

Job Title

 

language

string

Language

 

mobile

string

Mobile

 

name

string

Name

 

phone

string

Phone

 

time_zone

string

Time Zone

 

twitter_id

string

Twitter ID

 

updated_at

datetime

Updated at

 

view_all_tickets

boolean

View All Tickets

 

 

12-12-2020 13:14 Version 20.1.301-BETA+3023