Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Teamleader API Data Model

Navigation: Schema: V1 > Tables

users: Teamleader Users

Contents Previous Home Next More

Catalog: Teamleader

Schema: V1

Primary Keys: id

Label: Users

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

Select Teamleader API URL: getUsers.php

Insert Teamleader API URL: getUsers.php

Update Teamleader API URL: getUsers.php

Delete Teamleader API URL: getUsers.php

Field Selection Method: NotRequired

Table Function Parameters

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

show_inactive_users

int32

1

The default 1 selects all users. When set to 0, only active users will be selected.

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

active

string

Active

 

email

string

Email

 

gsm

string

Mobile Phone

 

id

int32

ID

 

name

string

Name

 

team_id

int32

Team ID

 

telephone

string

Telephone

 

title

string

Title

 

 

12-12-2020 19:52 Version 20.1.301-BETA+3023