Supported objects and operations
Workbooks is a cloud-based CRM and business application for users in sales, marketing, and customer support. It also offers services for order management and fulfillment, invoicing, and supplier management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
-
Connector name
-
API key for the cloud account (obtained from Start > Configuration > Email & Integration > API Keys in Workbooks Desktop instance)
-
Target URL of the cloud account
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Users
Table 158: Supported operations for Users
Get User |
GET |
Get All Users |
GET |
Groups
Not Applicable
Mandatory fields
Users
Not Applicable
Groups
Not Applicable
NOTE: Additional features supported: Workbooks connector supports attribute selection for the response based on the attributes mentioned in the query parameters ?attributes=.
User and Group mapping
The user and group mappings are listed in the tables below.
Table 159: User mapping
Id |
id |
userName |
login_name |
name.Formatted |
person_name |
displayName |
person_name |
emails[0].value |
login_name |
timezone |
timezone |
locale |
date_time_locale |
active |
is_enabled |
meta.created |
created_at |
meta.lastModified |
updated_at |
Groups
Not Applicable
Connector limitations
-
Create, Update, and Delete users are not supported.
-
Groups and group memberships are not supported through APIs.
-
Username is available only for the activated users.
-
Get All Users retrieves automation users that are not listed in the users list in Workbooks user interface. The automation users are created while generating the first API key of type automation in Workbooks Desktop instance.
-
The application returns the user details instead of 404 error though the user id is appended with alphabetic characters.
Mandatory fields
Workbooks is a cloud-based CRM and business application for users in sales, marketing, and customer support. It also offers services for order management and fulfillment, invoicing, and supplier management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
-
Connector name
-
API key for the cloud account (obtained from Start > Configuration > Email & Integration > API Keys in Workbooks Desktop instance)
-
Target URL of the cloud account
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Supported objects and operations
Users
Table 158: Supported operations for Users
Get User |
GET |
Get All Users |
GET |
Groups
Not Applicable
Users
Not Applicable
Groups
Not Applicable
NOTE: Additional features supported: Workbooks connector supports attribute selection for the response based on the attributes mentioned in the query parameters ?attributes=.
User and Group mapping
The user and group mappings are listed in the tables below.
Table 159: User mapping
Id |
id |
userName |
login_name |
name.Formatted |
person_name |
displayName |
person_name |
emails[0].value |
login_name |
timezone |
timezone |
locale |
date_time_locale |
active |
is_enabled |
meta.created |
created_at |
meta.lastModified |
updated_at |
Groups
Not Applicable
Connector limitations
-
Create, Update, and Delete users are not supported.
-
Groups and group memberships are not supported through APIs.
-
Username is available only for the activated users.
-
Get All Users retrieves automation users that are not listed in the users list in Workbooks user interface. The automation users are created while generating the first API key of type automation in Workbooks Desktop instance.
-
The application returns the user details instead of 404 error though the user id is appended with alphabetic characters.
User and Group mapping
Workbooks is a cloud-based CRM and business application for users in sales, marketing, and customer support. It also offers services for order management and fulfillment, invoicing, and supplier management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
-
Connector name
-
API key for the cloud account (obtained from Start > Configuration > Email & Integration > API Keys in Workbooks Desktop instance)
-
Target URL of the cloud account
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Supported objects and operations
Users
Table 158: Supported operations for Users
Get User |
GET |
Get All Users |
GET |
Groups
Not Applicable
Mandatory fields
Users
Not Applicable
Groups
Not Applicable
NOTE: Additional features supported: Workbooks connector supports attribute selection for the response based on the attributes mentioned in the query parameters ?attributes=.
The user and group mappings are listed in the tables below.
Table 159: User mapping
Id |
id |
userName |
login_name |
name.Formatted |
person_name |
displayName |
person_name |
emails[0].value |
login_name |
timezone |
timezone |
locale |
date_time_locale |
active |
is_enabled |
meta.created |
created_at |
meta.lastModified |
updated_at |
Groups
Not Applicable
Connector limitations
-
Create, Update, and Delete users are not supported.
-
Groups and group memberships are not supported through APIs.
-
Username is available only for the activated users.
-
Get All Users retrieves automation users that are not listed in the users list in Workbooks user interface. The automation users are created while generating the first API key of type automation in Workbooks Desktop instance.
-
The application returns the user details instead of 404 error though the user id is appended with alphabetic characters.
Connector limitations
Workbooks is a cloud-based CRM and business application for users in sales, marketing, and customer support. It also offers services for order management and fulfillment, invoicing, and supplier management.
Supervisor configuration parameters
To configure the connector, following parameters are required:
-
Connector name
-
API key for the cloud account (obtained from Start > Configuration > Email & Integration > API Keys in Workbooks Desktop instance)
-
Target URL of the cloud account
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Supported objects and operations
Users
Table 158: Supported operations for Users
Get User |
GET |
Get All Users |
GET |
Groups
Not Applicable
Mandatory fields
Users
Not Applicable
Groups
Not Applicable
NOTE: Additional features supported: Workbooks connector supports attribute selection for the response based on the attributes mentioned in the query parameters ?attributes=.
User and Group mapping
The user and group mappings are listed in the tables below.
Table 159: User mapping
Id |
id |
userName |
login_name |
name.Formatted |
person_name |
displayName |
person_name |
emails[0].value |
login_name |
timezone |
timezone |
locale |
date_time_locale |
active |
is_enabled |
meta.created |
created_at |
meta.lastModified |
updated_at |
Groups
Not Applicable
-
Create, Update, and Delete users are not supported.
-
Groups and group memberships are not supported through APIs.
-
Username is available only for the activated users.
-
Get All Users retrieves automation users that are not listed in the users list in Workbooks user interface. The automation users are created while generating the first API key of type automation in Workbooks Desktop instance.
-
The application returns the user details instead of 404 error though the user id is appended with alphabetic characters.