Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Freshdesk API Data Model

Navigation: Schema: Freshdesk > Tables

agent_by_id: Freshdesk Freshdesk Agent

Contents Previous Home Next More

Catalog: Freshdesk

Schema: Freshdesk

Primary Keys: id

Label: Freshdesk Agent

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: /agents/{id}

Insert Freshdesk API URL: /agents/{id}

Update Freshdesk API URL: /agents/{id}

Delete Freshdesk API URL: /agents/{id}

Field Selection Method: NotRequired

Table Function Parameters

The following parameters can be used to control the behaviour of the table function agent_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 agent_by_id are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

available

boolean

Available

 

available_since

datetime

Available since

 

contact_active

boolean

Contact Active

 

contact_created_at

datetime

Contact Created at

 

contact_email

string

Contact Email Address

 

contact_job_title

string

Contact Job Title

 

contact_language

string

Contact Language

 

contact_last_login_at

datetime

Contact Last Login at

 

contact_mobile

string

Contact Mobile Phone

 

contact_name

string

Contact Name

 

contact_phone

string

Contact Phone

 

contact_time_zone

string

Contact Time Zone

 

contact_updated_at

datetime

Contact Updated at

 

created_at

datetime

Created at

 

id

int64

ID

 

occasional

boolean

Occasional

 

signature

string

Signature

 

ticket_scope

int64

Ticket Scope

 

updated_at

datetime

Updated at

 

 

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