monday.com Connection Details
Introduction
Connector Version
This documentation is based on version 25.0.9368 of the connector.
Get Started
Monday Version Support
The connector leverages the Monday API to enable bidirectional access to Monday.
Establish a Connection
Connect to Monday
Monday AuditLog API
The Monday AuditLog API only supports authentication via API Token.
To generate the audit log API token:
- Log into your monday.com account.
- Click on your avatar (picture icon) in the top right corner of your screen.
- Select
Administrationfrom the resulting menu. - In the left-hand navigation, click
Security. - Click the
Audittab. - Click
Monitor by API > Copyto copy your AuditLog API token.
After you retrieve the API token, set the following connection properties:
- Schema: Set this to "AuditLog".
- AuthScheme:
Token - APIToken: The audit log API token you just obtained.
- URL: Your Monday account URL. You can copy the URL of your Monday homepage after logging in. For example:
https://your-account-name.monday.com/.
Monday GraphQL API
The Monday GraphQL API supports authentication via either API Token or the OAuth standard.
API Token
To connect to connector via an API Token, set the AuthScheme to Token and obtain the APIToken as follows:
- Log into your monday.com account.
- Click on your avatar (picture icon) in the top right corner of your screen.
- Select
Administrationfrom the resulting menu (this requires you to have admin permissions). - In the left-hand navigation, click
Connections, then click theAPItab in the resulting page. - Under
Personal API Token, clickCreate tokento create an personal API token. Set the APIToken connection property to this value.- If you've already made a token, under
Personal API Token, click theCopybutton to copy your API token. Set the APIToken connection property to this value.
- If you've already made a token, under
OAuth
Monday supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.
The following subsections describe how to authenticate to Monday from three common authentication flows:
Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.Web: access to data via a shared website.Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.
For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Monday, see Connection.
Desktop Applications
To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.
Get and refresh the OAuth access token:
- InitiateOAuth =
GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken. - OAuthClientId = the client ID assigned when you registered your application.
- OAuthClientSecret = the client secret that was assigned when you registered your application.
- CallbackURL = the redirect URI that was defined when you registered your application.
When you connect, the connector opens Monday's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector then completes the OAuth process:
- The connector obtains an access token from Monday and uses it to request data.
- The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
When the access token expires, the connector refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the connector automatically refresh the OAuth access token, do the following:
- The first time you connect to data, set the following connection parameters:
- InitiateOAuth =
REFRESH. - OAuthClientId = the client ID in your application settings.
- OAuthClientSecret = the client secret in your application settings.
- OAuthAccessToken = the access token.
- OAuthSettingsLocation = the path where you want the connector to save the OAuth values, which persist across connections.
- InitiateOAuth =
- On subsequent data connections, set the following:
Create a Custom OAuth Application
To create a custom OAuth application for use in Monday:
- Log in to your Monday account dashboard.
- Click the avatar icon and select
Developers. - In MyApps, click
Create App. - In the new application's
Basic Informationsection, record the application's OAuthClientId and OAuthClientSecret. - In the new application's
OAuthsection, enable the following scopes:- boards:read
- boards:write
- workspaces:read
- workspaces:write
- docs:read
- docs:write
- webhooks:read
- webhooks:write
- users:read
- account:read
- updates:read
- updates:write
- assets:read
- tags:read
- teams:read
- notifications:write
- If this OAuth app is intended for use in a Desktop app setup, specify this redirect URL:
http://localhost:3333.
GraphQL Limitations
Every GraphQL API has its own limitations. We cannot query an arbitrarily large number of nodes because the API returns an error if the connector exceeds the maximum cost. The query cost function is directly dependent on the page sizes. The connector uses its own algorithms for finding the page sizes but also gives you the freedom to tweak them based on your needs. There are two ways you can configure this behavior:
- Specify custom page size weights by including the
"other:pageSizeWeights"attribute. For example, suppose we have a "Customers" table which has two nested GraphQl connections, "businesses" and "customers". If you want a specific ratio between these two entities per query, such as 200 customers per 1 business, specify "other:pageSizeWeights=1:200" in the respective script. The advantage of this attribute is that you do not bypass our logic for finding the optimal page size based on the query cost. - Specify custom page sizes by including the
"other:pageSizes"attribute. By specifying this attribute, you bypass any check we do for query cost. Specify this attribute with caution, as you will encounter API errors if you exceed the maximum cost per query. Example: "other:pageSizeWeights=10,30", retrieves at most 10 businesses and at most 30 customers per business in one query.
Important Notes
Configuration Files and Their Paths
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features
This section details a selection of advanced features of the Monday connector.
User Defined Views
The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Monday and then processes the rest of the query in memory (client-side).
For further information, see Query Processing.
Log
For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.
User Defined Views
The Jitterbit Connector for Monday supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.
Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File
User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.
This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.
Alter a View
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views
In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.
Work with User Defined Views
For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration
Customize the SSL Configuration
By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
Data Model
The Jitterbit Connector for Monday models Monday data as an easy-to-use SQL database with tables, views, and stored procedures.
The provider exposes three kinds of schemas:
- The Information Data Model contains tables that structure and organize data related to work management on the Monday.com platform. It defines how boards, items, columns, and updates interact with each other.
- The AuditLog Data Model contains a table that provides a structured way to track and log system events and user actions.
- The Workspace Data Model contains tables that define the structure and organization of workspaces within a Monday.com account.
Information Data Model
In the Information Data Model schema, the provider models the data entities and relationships with the Monday.com platform as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Monday.com account are immediately reflected in the provider.
Tables
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you may have access to in your Monday account.
Common tables include:
| Table | Description |
|---|---|
Boards |
Retrieves a collection of boards, including their details and associated data. |
BoardUsers |
Retrieves a list of user subscribers for a specific board. |
BoardTeams |
Fetches a list of team subscribers associated with a specific board. |
Columns |
Retrieves the visible columns for a specific board, providing structural information. |
Groups |
Retrieves the visible groups for a specified board, providing a structured view of grouped items. |
BoardViews |
Retrieves a list of views configured for a specific board. |
Users |
Retrieves details about users within the Monday platform. |
Updates |
Fetches a collection of updates, including user comments, status changes, and other activity logs. |
Tags |
Retrieves a collection of tags used to categorize and filter items across boards. |
Teams |
Fetches metadata about teams in the Monday platform. |
Workspaces |
Retrieves a collection of workspaces, including their names and details. |
Webhooks |
Fetches a collection of webhooks, including their configuration and associated events. |
Folders |
Retrieves a collection of folders within workspaces. Excludes folders in closed workspaces unless you are subscribed to them. |
Docs |
Retrieves a collection of documents from workspaces, including their metadata. |
DocBlocks |
Fetches content blocks within documents associated with workspaces. |
BoardDocs |
Fetches a collection of documents associated with boards. Requires specifying an ID or ObjectId filter to identify the desired documents. |
BoardDocBlocks |
Retrieves content blocks from documents associated with boards. Requires a DocId or DocObjectId filter to narrow results. |
WorkspaceUsers |
Fetches the list of users subscribed to a specific workspace. |
WorkspaceTeams |
Retrieves the list of teams subscribed to a specific workspace. |
CustomActivities |
Retrieves metadata about custom activities in the Email and Activities timeline for enhanced activity tracking. |
Stored Procedures
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including duplicating items in a board, adding a file to a column value in a board, and sending a new notification to users.
Tables
The connector models the data in Monday as a list of tables in a relational database that can be queried using standard SQL statements.
Jitterbit Connector for Monday Tables
| Name | Description |
|---|---|
BoardDocBlocks |
Retrieves content blocks from documents associated with boards. Requires a DocId or DocObjectId filter to narrow results. |
BoardDocs |
Fetches a collection of documents associated with boards. Requires specifying an ID or ObjectId filter to identify the desired documents. |
Boards |
Retrieves a collection of boards, including their details and associated data. |
BoardTeams |
Fetches a list of team subscribers associated with a specific board. |
BoardUsers |
Retrieves a list of user subscribers for a specific board. |
Columns |
Retrieves the visible columns for a specific board, providing structural information. |
CustomActivities |
Retrieves metadata about custom activities in the Email and Activities timeline for enhanced activity tracking. |
DocBlocks |
Fetches content blocks within documents associated with workspaces. |
Docs |
Retrieves a collection of documents from workspaces, including their metadata. |
Folders |
Retrieves a collection of folders within workspaces. Excludes folders in closed workspaces unless you are subscribed to them. |
Groups |
Retrieves the visible groups for a specified board, providing a structured view of grouped items. |
Tags |
Retrieves a collection of tags used to categorize and filter items across boards. |
TeamUsers |
Retrieves the list of users assigned to a specific team. |
TimelineItems |
Provides metadata about items displayed in the Email and Activities timeline. |
Updates |
Fetches a collection of updates, including user comments, status changes, and other activity logs. |
Webhooks |
Fetches a collection of webhooks, including their configuration and associated events. |
Workspaces |
Retrieves a collection of workspaces, including their names and details. |
WorkspaceTeams |
Retrieves the list of teams subscribed to a specific workspace. |
WorkspaceUsers |
Fetches the list of users subscribed to a specific workspace. |
BoardDocBlocks
Retrieves content blocks from documents associated with boards. Requires a DocId or DocObjectId filter to narrow results.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Note
This table requires specifying DocId to retrieve data.
DocIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM BoardDocBlocks WHERE DocId = '9014425'
SELECT * FROM BoardDocBlocks WHERE DocId IN ('9014425','9014490')
SELECT * FROM BoardDocBlocks WHERE DocId IN (SELECT ColumnDocId FROM Board)
INSERT
The following inputs can be used in INSERT statements:
ParentBlockId, DocId, Content, Type, AfterBlockId
INSERT INTO BoardDocBlocks (DocId,Type,Content,AfterBlockId) VALUES ('9180448','code','{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"Test"}]}','53ab947f-226f-49f5-8d43-1021f9f36431')
UPDATE
The following inputs can be used in UPDATE statements:
Content
UPDATE BoardDocBlocks SET Content='{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"NewValue"}]}' WHERE ID = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
DELETE
You can delete entries by specifying the Id.
DELETE FROM BoardDocBlocks WHERE ID = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the block, used to distinguish it from other blocks in the document. | |
ParentBlockId |
String |
False | The unique identifier of the parent block, establishing hierarchical relationships between blocks. | |
DocId |
String |
False | BoardDocs.Id | The unique identifier of the document that contains this block. |
CreatedById |
String |
False | Users.Id | The unique identifier of the user who created the block. |
Position |
Double |
False | The position of the block within the document, used to determine its order. | |
Content |
String |
False | The content of the block, which could include text, media, or other data. | |
Type |
String |
False | Specifies the type of content stored in the block, such as text, image, or table. The allowed values are board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget. | |
CreatedAt |
Date |
False | The date when the block was initially created. | |
UpdatedAt |
Date |
False | The date when the block was last updated. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
AfterBlockId |
String |
Specifies the unique identifier of the block after which this block should be inserted. If not provided, the block will be inserted at the beginning of the document. |
BoardDocs
Fetches a collection of documents associated with boards. Requires specifying an ID or ObjectId filter to identify the desired documents.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Note
This table requires specifying either Id or ObjectId to retrieve data.
Idsupports the '=','IN' comparison operators.ObjectIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM BoardDocs WHERE Id = '9014425'
SELECT * FROM BoardDocs WHERE Id IN ('9014425','9014490')
SELECT * FROM BoardDocs WHERE Id IN (SELECT ColumnDocId FROM Board)
SELECT * FROM BoardDocs WHERE ObjectId = '5499548740'
SELECT * FROM BoardDocs WHERE ObjectId IN ('5499548740','5499563743')
SELECT * FROM BoardDocs WHERE ObjectId IN (SELECT ColumnObjectId FROM Board)
INSERT
The following inputs can be used in INSERT statements:
ItemId, ColumnId
INSERT INTO BoardDocs (ItemId, ColumnId) VALUES ('1647941525','monday_doc__1')
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | A unique identifier for the document within the system, ensuring each document is distinctly recognized. | |
ObjectId |
String |
False | The unique identifier of the object associated with this document, linking the document to its parent entity. | |
WorkspaceId |
String |
False | Workspaces.Id | The unique identifier of the workspace where the document resides. A null value indicates it belongs to the main workspace. |
CreatedById |
String |
False | Users.Id | The unique identifier of the user who created the document, allowing for tracking of document ownership. |
DocKind |
String |
False | Specifies the document's visibility or access type, such as public, private, or shared. The allowed values are public, private, share. | |
Name |
String |
False | The name assigned to the document, used for identification and display purposes. | |
RelativeUrl |
String |
False | The relative URL of the document, specifying its location within the application's directory structure. | |
Settings |
String |
False | A JSON or serialized string containing configuration and settings specific to the document. | |
Url |
String |
False | The direct URL link to access the document, typically used for navigation. | |
CreatedAt |
Date |
False | The date and time when the document was created, stored in the system's standard date format. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
ItemId |
String |
The unique identifier for the item associated with this document, linking it to its specific row or record. |
ColumnId |
String |
The unique identifier for the column associated with this document, representing its specific attribute or field. |
Boards
Retrieves a collection of boards, including their details and associated data.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.BoardKindsupports the '=' comparison operator.Statesupports the '=' comparison operator.WorkspaceIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Boards WHERE Id = '2182296646'
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030')
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030') AND BoardKind = 'public'
SELECT * FROM Boards WHERE BoardKind = 'public'
INSERT
The following inputs can be used in INSERT statements:
Name, Description, BoardKind, BoardFolderId, WorkspaceId, TemplateId, BoardOwnerIds, BoardOwnerTeamIds, BoardSubscriberIds, BoardSubscriberTeamIds, Empty
INSERT INTO Boards (WorkspaceId,BoardKind,Name,Description,BoardFolderId,BoardOwnerIds,BoardSubscriberTeamIds,Empty) VALUES ('3820334','public','NewBoard','A newly created board.','12689416','51688059,51085546','960990',true)
UPDATE
The following inputs can be used in UPDATE statements (note that due to API limitations only one column's value can be updated per statement):
Name, Description, Communication, State, BoardAttributes
UPDATE Boards SET Name = 'AnotherName' WHERE Id = '5549166043'
UPDATE Boards SET State = 'archived' WHERE ID = '5549166043'
DELETE
You can delete entries by specifying the Id.
DELETE FROM Boards WHERE ID = '5549166043'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | A unique identifier for the board, used to distinguish it from other boards in the system. | |
CreatorId |
String |
False | Users.Id | The unique identifier of the user who created the board. |
Name |
String |
False | The name of the board, representing its primary label or title. | |
ItemTerminology |
String |
False | Defines the terminology used for items on the board. Can be a predefined term or a custom value provided by the user. | |
ItemsCount |
Int |
False | The total number of items currently present on the board. | |
TopGroupId |
String |
False | Groups.Id | The unique identifier of the top-level group associated with this board. |
Description |
String |
False | A detailed description or summary of the board's purpose or content. | |
UpdatedAt |
Datetime |
False | The timestamp indicating when the board was last updated. | |
Type |
String |
False | Specifies the type of board object, such as a task board or project board. | |
Url |
String |
False | The direct URL link to access the board. | |
BoardKind |
String |
False | Indicates the kind of board, such as public, private, or shared, determining its visibility and access. The allowed values are public, private, share. | |
BoardFolderId |
String |
False | Folders.Id | A unique identifier for the board's folder within the system. |
Communication |
String |
False | Specifies the communication identifier associated with the board, typically a meeting ID or collaboration reference. | |
Permissions |
String |
False | Defines the permissions or access controls assigned to the board. | |
TagsIds |
String |
False | Tags.Id | A comma-separated list of unique identifiers for the tags associated with the board. |
State |
String |
False | Indicates the current state of the board, such as 'all', 'active', 'archived', or 'deleted'. | |
WorkspaceId |
String |
False | Workspaces.Id | The unique identifier of the workspace containing the board. A null value indicates the board belongs to the main workspace. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
TemplateId |
String |
Specifies the unique identifier of an optional template used to create the board. |
BoardOwnerIds |
String |
An optional, comma-separated list of user IDs representing the owners of the board. |
BoardOwnerTeamIds |
String |
An optional, comma-separated list of team IDs representing the owner teams of the board. |
BoardSubscriberIds |
String |
An optional, comma-separated list of user IDs representing subscribers to the board. |
BoardSubscriberTeamIds |
String |
An optional, comma-separated list of team IDs representing subscriber teams to the board. |
Empty |
Bool |
An optional flag indicating whether to create an empty board without any default items. |
BoardTeams
Fetches a list of team subscribers associated with a specific board.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
BoardIdsupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM BoardTeams WHERE BoardId='5557271485'
INSERT
Note
API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardTeams (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
DELETE
Note
API limitations may cause affected row counts to be reported inaccurately when attempting to delete relationships between entities that are not related.
You can delete entries by specifying the ID and BoardId.
DELETE FROM BoardTeams WHERE Id='51688059' AND BoardId='5546871560'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | Teams.Id | A unique identifier for each board team entry, ensuring distinct records in the table. |
BoardId [KEY] |
String |
False | Boards.Id | Represents the unique identifier of the board associated with the team, linking the team to its respective board. |
Kind |
String |
False | Specifies the role of the team within the board, such as 'subscriber' or 'owner'. Note that all owners are implicitly subscribers. Use this column to differentiate between owners and non-owner subscribers. The allowed values are owner, subscriber. |
BoardUsers
Retrieves a list of user subscribers for a specific board.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
BoardIdsupports the '=','IN' comparison operators.Kindsupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM BoardUsers WHERE BoardId = '5525287714'
SELECT * FROM BoardUsers WHERE Kind = 'owner'
INSERT
Note
API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardUsers (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
DELETE
Note
API limitations may cause affected row counts to be reported inaccurately when attempting to delete relationships between entities that are not related.
You can delete entries by specifying the ID and BoardId.
DELETE FROM BoardUsers WHERE ID = '51688059' AND BoardId = '5546871560'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | Users.Id | The unique identifier for the board owner, used to distinguish users associated with different boards. |
BoardId [KEY] |
String |
False | Boards.Id | The unique identifier of the board to which the user is linked. This is used to associate users with specific boards. |
Kind |
String |
False | Indicates the role of the user on the board. Valid roles are 'subscriber' or 'owner'. Owners are implicitly subscribers but can be differentiated using this column to filter non-owners. The allowed values are owner, subscriber. |
Columns
Retrieves the visible columns for a specific board, providing structural information.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.BoardIdsupports the '=','IN' comparison operator.Typesupports the '=','IN' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM Columns WHERE Id = 'name'
SELECT * FROM Columns WHERE ID IN ('name', 'status')
INSERT
The following inputs can be used in INSERT statements:
Id, BoardId, Settings, Title, Description, Type, AfterColumnId
INSERT INTO Columns (BoardId,Id,Type) VALUES ('3820334','custom_column_id_123','status')
UPDATE
The following inputs can be used in UPDATE statements (note that due to API limitations only one column's value can be updated per statement):
Title, Description
UPDATE Columns SET Title='AnotherName' WHERE Id='name' AND BoardId='3820334'
DELETE
You can delete entries by specifying the ID and BoardId.
DELETE FROM Boards WHERE Id='test' AND BoardId='3820334'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the column within its associated board. Ensures each column can be referenced individually. | |
BoardId [KEY] |
String |
False | Boards.Id | The unique identifier of the board to which the column belongs. Used to establish a relationship between the column and its parent board. |
Archived |
Bool |
False | Indicates whether the column is archived. A value of 'true' means the column is no longer actively used but remains stored for reference. | |
Settings |
String |
False | Contains the column's settings stored in a serialized string format. These settings define the column's configuration and behavior. | |
Title |
String |
False | The display name or title of the column, used to identify its purpose or content visually. | |
Description |
String |
False | A detailed description of the column's purpose or content. Provides additional context for users. | |
Type |
String |
False | Specifies the type of the column, indicating its role or the kind of data it contains (for example, 'text', 'number', 'date'). The allowed values are auto_number, board_relation, button, checkbox, color_picker, country, creation_log, date, dependency, doc, dropdown, email, file, formula, group, hour, integration, item_assignees, item_id, last_updated, link, location, long_text, mirror, name, numbers, people, person, phone, progress, rating, status, subtasks, tags, team, text, time_tracking, timeline, unsupported, vote, week, world_clock. | |
Width |
Int |
False | Defines the width of the column in terms of pixels or a similar unit. Determines how much screen space the column occupies. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
AfterColumnId |
String |
The unique identifier of the column after which the current column will be inserted. Used to specify the placement of a new column relative to existing ones. |
CustomActivities
Retrieves metadata about custom activities in the Email and Activities timeline for enhanced activity tracking.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.Namesupports the '=' comparison operator.IconIdsupports the '=' comparison operator.Colorsupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM CustomActivities WHERE Id ='a91e9318-798a-44a6-80a4-49a14e23c015'
SELECT * FROM CustomActivities WHERE Color ='MEDIUM_TURQUOISE'
INSERT
The following inputs can be used in INSERT statements:
Name, IconId, Color
INSERT INTO CustomActivities (Name, IconId, Color) values ('CActivity', 'CAMERA', 'MEDIUM_TURQUOISE')
DELETE
You can delete entries by specifying the Id.
DELETE FROM CustomActivities WHERE Id='a91e9318-798a-44a6-80a4-49a14e23c015'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the custom activity, used to reference and distinguish it from other activities in the system. | |
Type |
String |
False | The classification of the custom activity, indicating its role or category within the broader activity framework (for example, 'Workflow', 'Task'). | |
Name |
String |
False | The human-readable name of the custom activity, displayed in user interfaces or reports to identify it. | |
IconId |
String |
False | An identifier corresponding to the icon representing the custom activity, used to visually distinguish it in the user interface. The allowed values are ASCENDING, CAMERA, CONFERENCE, FLAG, GIFT, HEADPHONES, HOMEKEYS, LOCATION, NOTEBOOK, PAPERPLANE, PLANE, PLIERS, TRIPOD, TWOFLAGS, UTENCILS. | |
Color |
String |
False | The color associated with the custom activity, typically used for visual categorization or to provide a thematic representation in the UI. The allowed values are BRINK_PINK, CELTIC_BLUE, CORNFLOWER_BLUE, DINGY_DUNGEON, GO_GREEN, GRAY, LIGHT_DEEP_PINK, LIGHT_HOT_PINK, MAYA_BLUE, MEDIUM_TURQUOISE, PARADISE_PINK, PHILIPPINE_GREEN, PHILIPPINE_YELLOW, SLATE_BLUE, VIVID_CERULEAN, YANKEES_BLUE, YELLOW_GREEN, YELLOW_ORANGE. |
DocBlocks
Fetches content blocks within documents associated with workspaces.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
DocIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM DocBlocks WHERE DocId = '9014425'
SELECT * FROM DocBlocks WHERE DocId IN ('9014425','9014490')
INSERT
The following inputs can be used in INSERT statements:
ParentBlockId, DocId, Content, Type, AfterBlockId
INSERT INTO DocBlocks (DocId,Type,Content,AfterBlockId) VALUES ('9180448','code','{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"Test"}]}','53ab947f-226f-49f5-8d43-1021f9f36431')
UPDATE
The following inputs can be used in UPDATE statements:
Content
UPDATE DocBlocks SET Content = '{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"NewValue"}]}' WHERE ID = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
DELETE
You can delete entries by specifying the Id.
DELETE FROM DocBlocks WHERE ID = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the block within the document, ensuring each block can be individually referenced and tracked. | |
ParentBlockId |
String |
False | The unique identifier of the block's parent, establishing the hierarchical relationship between blocks in the document structure. | |
DocId |
String |
False | Docs.Id | The unique identifier for the document to which the block belongs, helping link blocks to specific documents in the system. |
CreatedById |
String |
False | Users.Id | The unique identifier of the user who created the block, allowing traceability of the block's origin and providing context for audit trails. |
Position |
Double |
False | The position of the block within the document, typically represented as a floating-point number to precisely determine its order or location relative to other blocks. | |
Content |
String |
False | The actual content of the block, which may include text, media, or other data, depending on the block type and intended usage. | |
Type |
String |
False | The type of content within the block, indicating whether it contains text, an image, or another format, helping to differentiate the block's role in the document. The allowed values are board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget. | |
CreatedAt |
Date |
False | The date and time when the block was created, providing a timestamp for when it was initially added to the document. | |
UpdatedAt |
Date |
False | The date and time when the block was last modified, tracking when changes were made to the block's content or attributes. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
AfterBlockId |
String |
The identifier of the block that should appear immediately before the current block, allowing precise control over the order of blocks within a document. If not provided, the block will be inserted first in the document. |
Docs
Retrieves a collection of documents from workspaces, including their metadata.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.ObjectIdsupports the '=','IN' comparison operators.WorkspaceIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Docs WHERE Id = '9014425'
SELECT * FROM Docs WHERE Id IN ('9014425','9014490')
SELECT * FROM Docs WHERE ObjectId = '5499548740'
SELECT * FROM Docs WHERE ObjectId IN ('5499548740','5499563743')
SELECT * FROM Docs WHERE WorkspaceId = '3578971'
INSERT
The following inputs can be used in INSERT statements:
WorkspaceId, DocKind, Name
INSERT INTO Docs (WorkspaceId,DocKind,Name) VALUES ('3820334','public','CreatedDoc')
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | A unique identifier assigned to the document, used to reference and distinguish the document in the system. | |
DocFolderId |
String |
False | Folders.Id | The identifier of the folder where the document is stored. If the document is at the first level (root), this value is null. |
ObjectId |
String |
False | The unique identifier of the object associated with the document, allowing linkage between the document and the corresponding object in the system. | |
WorkspaceId |
String |
False | Workspaces.Id | The identifier for the workspace where the document is located. If the document is in the main workspace, this value is null. |
CreatedById |
String |
False | Users.Id | The unique identifier of the user who created the document, linking it to the creator's profile for tracking purposes. |
DocKind |
String |
False | Specifies the document's classification: public (accessible to all), private (restricted access), or shared (accessible to specific users). The allowed values are public, private, share. | |
Name |
String |
False | The name or title of the document, typically used to identify it within the system or user interface. | |
RelativeUrl |
String |
False | The relative URL path of the document, which can be used to access it within the web application's context. | |
Settings |
String |
False | Stores configuration settings or preferences associated with the document, such as display or security settings. | |
Url |
String |
False | The direct, fully qualified URL that provides access to the document, usable for linking or direct access via a browser. | |
CreatedAt |
Date |
False | The timestamp representing when the document was created, useful for auditing and sorting documents chronologically. |
Folders
Retrieves a collection of folders within workspaces. Excludes folders in closed workspaces unless you are subscribed to them.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.WorkspaceIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Folders WHERE Id = '12622355'
SELECT * FROM Folders WHERE WorkspaceId = '3578971'
INSERT
The following inputs can be used in INSERT statements:
ParentId, WorkspaceId, Color, Name
INSERT INTO Folders (WorkspaceId,Name,Color) VALUES ('3578971','TestFolder','BRIGHT_BLUE')
UPDATE
The following inputs can be used in UPDATE statements:
ParentId, Color, Name
UPDATE Folders SET Color = 'SUNSET', Name = 'UpdatedName' WHERE ID = '12678064'
DELETE
You can delete entries by specifying the Id.
DELETE FROM Folders WHERE Id='12678064'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | A unique identifier for the folder, used to reference the folder in the system or database. | |
OwnerId |
String |
False | Users.Id | The unique identifier of the user who owns the folder, linking it to the user profile responsible for the folder. |
ParentId |
String |
False | The unique identifier of the folder's parent, allowing for hierarchical folder structures. This helps in organizing folders within a larger directory structure. | |
SubFolderIds |
String |
False | A list of unique identifiers for the subfolders contained within the current folder, enabling a nested folder structure. | |
WorkspaceId |
String |
False | Workspaces.Id | The unique identifier of the workspace that the folder belongs to, helping to associate the folder with a specific project or team environment. |
Color |
String |
False | The color assigned to the folder for visual identification or categorization, often used to visually differentiate between folders in the user interface. The allowed values are DONE_GREEN, BRIGHT_GREEN, WORKING_ORANGE, DARK_ORANGE, SUNSET, STUCK_RED, DARK_RED, SOFIA_PINK, LIPSTICK, PURPLE, DARK_PURPLE, INDIGO, BRIGHT_BLUE, AQUAMARINE, CHILI_BLUE, NULL. | |
Name |
String |
False | The name given to the folder, typically representing its content or purpose, and displayed in the system for easy identification. | |
CreatedAt |
Datetime |
False | The timestamp of when the folder was created, which helps track the folder's age and historical changes. |
Groups
Retrieves the visible groups for a specified board, providing a structured view of grouped items.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.BoardIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Groups WHERE Id = 'topics'
SELECT * FROM Groups WHERE Id IN ('topics', 'group_title')
SELECT * FROM Groups WHERE BoardId IN ('2182296646', '21822966')
SELECT * FROM Groups WHERE BoardId = '2182296646' AND ID = 'topics'
INSERT
The following inputs can be used in INSERT statements:
BoardId, Title, RelativeTo, PositionRelativeMethod
INSERT INTO Groups (BoardId,Title,Color,RelativeTo,PositionRelativeMethod) VALUES ('5525287714','NewGroup','#9CD326','testgroup','after_at')
UPDATE
The following inputs can be used in UPDATE statements (note that due to API limitations only one column's value can be updated per statement):
Archived, Color, Title, RelativePositionAfter, RelativePositionBefore
UPDATE Groups SET Color = '#9CD326' WHERE BoardId = '5525287714' AND Id = 'newgroup'
UPDATE Groups SET Archived = 'true' WHERE BoardId='5525287714' AND ID = 'newgroup'
DELETE
You can delete entries by specifying the ID and BoardId.
DELETE FROM Groups WHERE BoardId = '5525287714' AND ID = 'testgroup'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier assigned to the group within the system, ensuring that each group can be referenced distinctly. | |
BoardId [KEY] |
String |
False | Boards.Id | The unique identifier of the board to which the group belongs, linking the group to a specific board in the database. |
BoardURL |
String |
False | The URL of the board associated with the group, providing a direct link for accessing the board in the web interface. | |
Archived |
Bool |
False | A flag indicating whether the group is archived. A value of true means the group is archived and no longer actively used. | |
Color |
String |
False | The color associated with the group, typically used for visual identification or categorization within the board. The allowed values are #037f4c, #fdab3d, #579bfc, #e2445c, #00c875, #c4c4c4, #0086c0, #a25ddc, #ffcb00, #9cd326, #7f5347, #bb3354, #808080, #784bd1, #ff642e, #ff158a, #66ccff, #ff5ac4, #cab641. | |
Deleted |
Bool |
False | A flag that indicates whether the group has been deleted. A value of true means the group has been removed from the system. | |
Position |
String |
False | A string representing the position of the group on the board, often used for ordering groups in a list or layout. | |
Title |
String |
False | The title or name of the group, which provides a human-readable identifier for the group within the board. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
RelativeTo |
String |
Specifies the group relative to which the current group's position should be set. This helps in defining the ordering between groups. |
PositionRelativeMethod |
String |
Describes the method used to determine the group's position relative to another group. Possible values include 'before_at' and 'after_at'. The allowed values are before_at, after_at. |
RelativePositionAfter |
String |
Defines the position of the group relative to another group, specifically indicating that it should appear after the referenced group on the board. |
RelativePositionBefore |
String |
Defines the position of the group relative to another group, specifying that it should appear before the referenced group on the board. |
Tags
Retrieves a collection of tags used to categorize and filter items across boards.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.IsPrivatesupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE Id = '13327214'
SELECT * FROM Tags WHERE ID IN ('13327214', '13327217')
INSERT
The following inputs can be used in INSERT statements:
Name, BoardId
INSERT INTO Tags (Name) VALUES ('TestTagName')
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the tag, used to reference and distinguish it across the system. | |
Color |
String |
False | The color associated with the tag, which may be used to visually categorize or highlight the tag in the user interface. | |
Name |
String |
False | The name of the tag, typically used to describe or categorize items, and displayed in the user interface. | |
IsPrivate |
Bool |
False | Indicates whether the tag is private (visible only to specific users or groups) or public (accessible to everyone in the system). | |
BoardId |
String |
False | The identifier for a private board where the tag is created or filtered, relevant only for private boards, and not required for public boards. |
TeamUsers
Retrieves the list of users assigned to a specific team.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
TeamIdsupports the '=','IN' comparison operators.Kindsupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM TeamUsers WHERE TeamId = '3578971'
SELECT * FROM TeamUsers WHERE Kind = 'owner'
INSERT
Note
API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following inputs can be used in INSERT statements:
Id, TeamId
INSERT INTO TeamUsers (Id, TeamId) VALUES ('57410919', '1127299')
DELETE
Note
API limitations may cause affected row counts to be reported inaccurately when attempting to delete relationships between entities that are not related.
You can delete entries by specifying the ID and TeamId.
DELETE FROM TeamUsers WHERE ID = '51688059' AND TeamId = '3820334'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | Users.Id | A unique identifier for the user within the system, used to differentiate and reference individual users across various processes and tables. |
TeamId [KEY] |
String |
False | Teams.Id | A unique identifier for the team to which the user is assigned, enabling team-based filtering and operations within the platform. |
Kind |
String |
False | The user's role. All owners are by default also members. This column can be used to filter non-owners. |
TimelineItems
Provides metadata about items displayed in the Email and Activities timeline.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.
For example, the following query is processed server side:
SELECT * FROM TimelineItems WHERE ID ='2b748808-9311-4f76-80de-49baac5609e1'
INSERT
The following inputs can be used in INSERT statements:
Title, CustomActivityId, ItemId, Summary, Content, Location, Phone, Url, Timestamp, TimeRangeStartTimestamp, TimeRangeEndTimestamp
INSERT INTO TimelineItems(ItemId, CustomActivityId, Location, Title, Summary, Content, Timestamp, TimeRangeStartTimestamp, TimeRangeEndTimestamp, phone, URL) VALUES ( '7832826517', '8baadd0b-5b64-4ecb-a035-1f5824507f98', 'X', 'Migrated Timeline', 'Works summary', 'Test', '2024-06-06T18:00:30Z', '2024-04-06T15:00:30Z', '2024-05-06T19:00:30Z', '1234-5678', 'https://www.test.com');
DELETE
You can delete entries by specifying the Id.
DELETE FROM TimelineItems WHERE Id='2b748808-9311-4f76-80de-49baac5609e1'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the timeline item, used to reference and track this specific item across the system. | |
Type |
String |
False | Indicates the type of the timeline item, which helps categorize the item (for example task, event, milestone). | |
Title |
String |
False | The title or brief name of the timeline item, providing a summary of its purpose or content. | |
CustomActivityId |
String |
False | The external identifier associated with a custom activity related to the timeline item, useful for integrating with other systems or tools. | |
Content |
String |
False | The detailed content or description of the timeline item, which could include notes, tasks, or additional context about the item. | |
Timestamp |
Datetime |
False | The creation time of the event associated with the timeline item, used to track when the item was created or modified. | |
UserId |
String |
False | The unique identifier of the user who created the timeline item, linking it to a specific user in the system. | |
UserName |
String |
False | The name of the user who created the timeline item, providing context to identify the creator. | |
ItemId |
String |
False | The unique identifier of the item that this timeline item is associated with, typically used to link it to a broader project or task. | |
BoardId |
String |
False | The unique identifier of the board where the timeline item is placed, helping to associate the item with a specific project or team. | |
BoardName |
String |
False | The name of the board where the timeline item resides, providing more readable context about the item's location. | |
BoardWorkspaceId |
String |
False | The unique identifier of the workspace where the board resides, helping to categorize the board within a specific workspace or team. | |
BoardWorkspaceName |
String |
False | The name of the workspace associated with the board, offering a human-readable context of where the board is located. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
Summary |
String |
A brief summary or overview of the timeline item, typically used to provide a high-level description of the item. |
Location |
String |
The location associated with the timeline item, such as an address, region, or venue, providing geographic context. |
Phone |
String |
The phone number associated with the timeline item, often used for contact purposes related to the item. |
Url |
String |
A URL linked to the timeline item, such as a related document, website, or resource for further information. |
TimeRangeStartTimestamp |
Datetime |
The starting timestamp for a time range associated with the timeline item, such as the beginning of a scheduled event or activity. |
TimeRangeEndTimestamp |
Datetime |
The ending timestamp for a time range associated with the timeline item, marking the conclusion of a scheduled event or activity. |
Updates
Fetches a collection of updates, including user comments, status changes, and other activity logs.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.BoardIdsupports the '=' comparison operator.ItemIdsupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM Updates WHERE Id = '173981152'
SELECT * FROM Updates WHERE Id IN ('173981152','173981153')
SELECT * FROM Updates WHERE ItemId = '1388002886'
SELECT * FROM Updates WHERE BoardId = '1388002765'
INSERT
The following inputs can be used in INSERT statements:
Body, ItemId, ParentId
INSERT INTO Updates (ItemId,Body,ParentId) VALUES ('5525287847','This is a new reply.','2553498004')
DELETE
You can delete entries by specifying the Id.
DELETE FROM Updates WHERE ID = '2553512994'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the update, ensuring each update can be individually referenced and tracked in the database. | |
Body |
String |
False | The HTML-formatted content of the update, which may include various HTML tags for styling and media embedding. | |
CreatedAt |
Datetime |
False | The timestamp when the update was first created, providing the exact date and time of its creation. | |
CreatorId |
String |
False | Users.Id | The unique identifier of the user who created the update, enabling tracking of authorship and accountability. |
ItemId |
String |
False | The unique identifier for the item associated with the update, linking it to the corresponding item in the database. | |
PinnedToTopItemIds |
String |
False | A comma-separated list of item IDs where the update is pinned, ensuring visibility by keeping it at the top of the list. | |
TextBody |
String |
False | The plain-text content of the update, providing the core message without any HTML formatting. | |
UpdatedAt |
Datetime |
False | The timestamp when the update was last modified, tracking any subsequent changes after the original creation. | |
EditedAt |
Datetime |
False | The date the update's body was last edited. | |
AssetsIds |
String |
False | Assets.Id | A comma-separated list of unique identifiers for the files or assets attached to the update, such as images or documents. |
Replies |
String |
False | A list of replies associated with the update, typically stored as a comma-separated list of reply IDs or user responses. | |
Reactions |
String |
False | A data field that tracks user reactions to the update, which can include likes, emojis, or other forms of engagement. | |
BoardId |
String |
False | The unique identifier for the board to which the update belongs, allowing for filtering updates by specific boards or categories. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
ParentId |
String |
The unique identifier of the parent update, used for creating threaded discussions or replies related to the original update. |
Webhooks
Fetches a collection of webhooks, including their configuration and associated events.
Table-Specific Information
Select
The connector uses the Monday API to process WHERE clause conditions built with the following column and operator. The connector processes other filters client-side within the connector.
BoardIdsupports the '=' comparison operator.
For example, the following query is processed server side:
SELECT * FROM Webhooks WHERE BoardId = '5574930939'
INSERT
The following inputs can be used in INSERT statements:
BoardId, Config, Event, Url
INSERT INTO Webhooks (BoardId,Config,Event,Url) VALUES ('5574930939','{\"columnId\":\"status\", \"columnValue\":{\"$any$\":true}}','change_status_column_value','https://test.com/')
DELETE
You can delete entries by specifying the Id.
DELETE FROM Webhooks WHERE ID = '242031214'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the webhook, used to distinguish it from other webhooks in the system. | |
BoardId |
String |
False | The unique identifier for the board associated with the webhook, helping to identify which board the webhook is tied to. | |
Config |
String |
False | A JSON or similar configuration format detailing the settings and preferences for the webhook, including event types, filters, and other parameters. | |
Event |
String |
False | The specific event or trigger that the webhook listens to, such as a change in status or a new task being created. The allowed values are change_column_value, create_column, change_status_column_value, change_subitem_column_value, change_specific_column_value, create_item, create_subitem, create_update, edit_update, delete_update, create_subitem_update, change_subitem_name, change_name, item_deleted, subitem_deleted, item_archived, subitem_archived, item_restored, item_moved_to_any_group, item_moved_to_specific_group, move_subitem. | |
AppWebhooksOnly |
Bool |
False | A filter to include only webhooks created by the application initiating the request, excluding any manually created or external webhooks. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
Url |
String |
The URL to which the webhook sends its notifications, typically used to deliver event data to a specified endpoint. |
Workspaces
Retrieves a collection of workspaces, including their names and details.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.Kindsupports the '=' comparison operator.Statesupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM Workspaces WHERE Id = '3578971'
SELECT * FROM Workspaces WHERE Id IN ('3578971','3578972')
SELECT * FROM Workspaces WHERE Kind = 'open'
SELECT * FROM Workspaces WHERE State = 'active'
INSERT
The following inputs can be used in INSERT statements:
Description, Kind, Name
INSERT INTO Workspaces (Name,Kind,Description) VALUES ('New Workspace','open','This is my new workspace.')
UPDATE
The following inputs can be used in INSERT statements:
Id, Description, Name, Kind
UPDATE Workspaces SET Description = 'testDescription', Name = 'testName', Kind = 'open' WHERE ID = '3819431'
DELETE
You can delete entries by specifying the Id.
DELETE FROM Workspaces WHERE ID = '3819431'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the workspace, used to distinguish it from other workspaces within the platform. | |
Description |
String |
False | A brief textual description of the workspace, providing context or details about its purpose or contents. | |
Kind |
String |
False | Indicates whether the workspace is currently open or closed, helping to categorize the workspace's availability. The allowed values are open, closed. | |
Name |
String |
False | The name assigned to the workspace, typically used for identification in the user interface. | |
State |
String |
False | Describes the current state of the workspace, which can be 'all', 'active', 'archived', or 'deleted', indicating its lifecycle status. | |
CreatedAt |
Datetime |
False | The timestamp representing when the workspace was initially created, useful for auditing and time-based queries. | |
AccountProductId |
String |
False | The identifier for the specific product associated with the account, linking the workspace to its product type or plan. | |
AccountProductKind |
String |
False | Specifies the type of product tied to the account, such as core, marketing, CRM, software, project management, forms, or whiteboard. | |
SettingsIconColor |
String |
False | The color code (in hex format) used as the background color for the workspace's icon, allowing for customization in the user interface. | |
SettingsIconImage |
String |
False | A URL pointing to the image used as the workspace's icon. If the image is uploaded by the user, the URL is temporary and needs to be refreshed periodically. The first letter of the workspace name is used as a fallback when the image is not available. | |
IsDefaultWorkspace |
String |
False | Indicates whether this workspace is set as the default for the account or product, which may affect the user's experience and default settings. | |
ItemURL |
String |
False | The URL associated with the workspace, providing direct access or linking to resources or data within the workspace. |
WorkspaceTeams
Retrieves the list of teams subscribed to a specific workspace.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
WorkspaceIdsupports the '=' comparison operator.Kindsupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM WorkspaceTeams WHERE Kind = 'owner'
SELECT * FROM WorkspaceTeams WorkspaceId = '3820334'
INSERT
Note
API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following inputs can be used in INSERT statements:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','subscriber')
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','owner')
DELETE
You can delete entries by specifying the ID and WorkspaceId.
DELETE FROM WorkspaceTeams WHERE ID = '961021' AND WorkspaceId = '3820334'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier for the team, used to distinguish each team within the system. This ID is referenced in other tables or operations to identify the specific team. | |
WorkspaceId [KEY] |
String |
False | The unique identifier for the workspace to which the team belongs. It is used to associate the team with a specific workspace for collaboration or access control purposes. | |
Kind |
String |
False | Defines the team’s role within the workspace. The role can be 'subscriber' or 'owner', where owners have additional permissions compared to subscribers. This column is useful for filtering and managing access levels. The allowed values are owner, subscriber. |
WorkspaceUsers
Fetches the list of users subscribed to a specific workspace.
Table-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
WorkspaceIdsupports the '=' comparison operator.Kindsupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM WorkspaceUsers WHERE WorkspaceId = '3578971'
SELECT * FROM WorkspaceUsers WHERE Kind = 'owner'
INSERT
Note
API limitations may cause affected row counts or generated keys to be reported inaccurately when attempting to create relationships between entities that are already related.
The following inputs can be used in INSERT statements:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceUsers (Id,WorkspaceId,Kind) VALUES ('51688059','3820334','subscriber')
DELETE
You can delete entries by specifying the ID and WorkspaceId.
DELETE FROM WorkspaceUsers WHERE ID = '51688059' AND WorkspaceId = '3820334'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
Id [KEY] |
String |
False | The unique identifier assigned to each user, used to distinguish between different users within the system. | |
WorkspaceId [KEY] |
String |
False | The unique identifier for the workspace to which the user belongs, linking the user to a specific workspace or project. | |
Kind |
String |
False | The role assigned to the user within the workspace, such as 'subscriber' or 'owner.' All users with the 'owner' role are automatically granted 'subscriber' privileges. This field can be used to filter or identify users with specific roles, like non-owners. The allowed values are owner, subscriber. |
Views
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Jitterbit Connector for Monday Views
| Name | Description |
|---|---|
ActivityLogs |
Fetches the activity log events associated with a specific board, detailing recent updates and actions. |
Assets |
Retrieves a collection of assets based on provided asset IDs, such as files or media associated with items. |
BoardViews |
Fetches a list of views configured for a specific board. |
Teams |
Fetches a collection of teams, including their details and associated users. |
UpdateViewers |
Retrieves the viewers associated with updates. |
Users |
Retrieves a collection of users, including their details and roles. |
ActivityLogs
Fetches the activity log events associated with a specific board, detailing recent updates and actions.
View-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
BoardIdsupports the '=','IN' comparison operators.UserIdsupports the '=','IN' comparison operators.CreatedAtsupports the '<','<=','>','>=' comparison operators.ColumnIdsupports the '=','IN' comparison operators.GroupIdsupports the '=','IN' comparison operators.ItemIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM ActivityLogs WHERE BoardId IN ('2307103055', '2182296646')
SELECT * FROM ActivityLogs WHERE UserId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ColumnId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE GroupId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ItemId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE CreatedAt > '2022-02-17 05:12:04.419' AND CreatedAt < '2022-02-17 05:12:04.861'
SELECT * FROM ActivityLogs WHERE CreatedAt >= '2022-02-17 05:12:04.419' AND CreatedAt <= '2022-02-17 05:12:04.861'
Columns
| Name | Type | References | Description |
|---|---|---|---|
Id [KEY] |
String |
The unique identifier of the activity log event, used to track and retrieve specific log entries. | |
BoardId |
String |
Boards.id | The unique identifier of the board associated with the activity, providing context for the event. |
AccountId |
String |
The unique identifier of the account that initiated the activity, useful for auditing and tracking purposes. | |
UserId |
String |
Users.Id | The unique identifier of the user who triggered the activity, enabling user-specific analysis and reporting. |
CreatedAt |
Datetime |
The timestamp indicating when the activity event occurred, formatted in datetime. | |
Data |
String |
A serialized string representation of the item's column values at the time of the event. | |
Entity |
String |
Specifies the entity affected by the event, such as a 'pulse' (task) or 'board' (project). | |
Event |
String |
Describes the specific action that occurred, such as an Update, Delete, or Create operation. | |
ColumnId |
String |
The unique identifier of the column affected by the activity, used for filtering and analysis. | |
GroupId |
String |
Groups.Id | The unique identifier of the group within the board affected by the activity, used for context or filtering. |
ItemId |
String |
The unique identifier of the item (task or object) within the board affected by the activity, used for detailed tracking and filtering. |
Assets
Retrieves a collection of assets based on provided asset IDs, such as files or media associated with items.
View-Specific Information
SELECT
Note
The ID filter is required to retrieve data from this table.
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Assets WHERE Id = '397532775'
SELECT * FROM Assets WHERE ID IN ('397532775', '397532776')
Columns
| Name | Type | References | Description |
|---|---|---|---|
Id [KEY] |
String |
The unique identifier assigned to the file in the system for tracking and referencing purposes. | |
Name |
String |
The name of the file, as specified during upload or creation. | |
CreatedAt |
Datetime |
The date and time when the file was created or uploaded, stored in datetime format. | |
FileExtension |
String |
The file extension indicating the format or type of the file, such as '.jpg', '.png', or '.pdf'. | |
FileSize |
Int |
The size of the file in bytes, providing an indication of storage usage. | |
OriginalGeometry |
String |
The original dimensions or geometry of the asset, typically used for images or spatial files. | |
PublicUrl |
String |
A temporary public URL to access the asset directly. The URL is valid for 1 hour after being generated. | |
UploadedById |
String |
Users.Id | The unique identifier of the user who uploaded the file to the system. |
Url |
String |
The URL to access and view the asset directly in its original form. | |
UrlThumbnail |
String |
The URL to access and view the asset as a thumbnail. This is only available for image files. |
BoardViews
Fetches a list of views configured for a specific board.
View-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.BoardIdsupports the '=','IN' comparison operators.Typesupports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM BoardViews WHERE BoardId = '2182296646'
SELECT * FROM BoardViews WHERE Type = 'Chart'
SELECT * FROM BoardViews WHERE BoardId IN ('2182296646', '2181960030')
Columns
| Name | Type | References | Description |
|---|---|---|---|
Id [KEY] |
String |
A unique identifier for the board view. Used to distinguish this view from others. | |
BoardId |
String |
Boards.Id | The unique identifier of the board to which this view belongs. Links the view to its parent board. |
Name |
String |
The name of the board view, typically used for identification and display purposes. | |
Settings |
String |
The settings for the board view, stored as a string. Includes configurations specific to this view. | |
Type |
String |
The type of the board view, indicating its category or functionality (for example, Kanban, Calendar). | |
ViewSpecificData |
String |
Additional data specific to this board view. Supported only for form-based views and stored in a string format. | |
SourceViewId |
String |
The unique identifier of the template view if this view was created as a duplicate of another view. |
Teams
Fetches a collection of teams, including their details and associated users.
View-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM Teams WHERE Id = '565332'
SELECT * FROM Teams WHERE ID IN ('565332, 565333')
Columns
| Name | Type | References | Description |
|---|---|---|---|
Id [KEY] |
String |
The unique identifier for the team, used to reference the team across the system. This ID ensures that each team can be distinguished and managed independently. | |
Name |
String |
The name of the team, which can be used to identify the team in user interfaces, reports, or other parts of the system. | |
PictureUrl |
String |
The URL link to the team's picture or logo, used for displaying visual representations of the team in the application or on web pages. |
UpdateViewers
Retrieves the viewers associated with updates.
View-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
UpdateIdsupports the '=','IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM UpdateViewers WHERE UpdateId = '3578971'
Columns
| Name | Type | References | Description |
|---|---|---|---|
Id [KEY] |
String |
The viewer's unique identifier. | |
Medium |
String |
The channel through which the user views the update. | |
UpdateId [KEY] |
String |
Updates.Id | The update's unique identifier. |
Users
Retrieves a collection of users, including their details and roles.
View-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Idsupports the '=','IN' comparison operators.Emailsupports the '=','IN' comparison operators.IsGuestsupports the '=' comparison operator.IsPendingsupports the '=' comparison operator.NonActivesupports the '=' comparison operator.TeamsIdssupports the '=','IN' comparison operators when filtering for users that belong to a single team.
For example, the following queries are processed server side:
SELECT * FROM Users ORDER BY CreatedAt DESC
SELECT * FROM Users WHERE IsPending = true
SELECT * FROM Users WHERE IsGuest = true
SELECT * FROM Users WHERE Id = '27278379'
SELECT * FROM Users WHERE Id IN ('27278379', '27278377')
SELECT * FROM Users WHERE Email = 'test@cdata.com'
SELECT * FROM Users WHERE Email IN ('test@cdata.com', 'test@gmail.com')
SELECT * FROM Users WHERE TeamsIds = '915408'
Columns
| Name | Type | References | Description |
|---|---|---|---|
Id [KEY] |
String |
The unique identifier for the user, used to reference the user across the system. | |
TeamsIds |
String |
A list of unique identifiers for the teams the user belongs to, helping to track user membership within teams. | |
Name |
String |
The full name of the user, used for identification and display purposes. | |
Phone |
String |
The user's primary phone number, used for contact and verification. | |
Birthday |
Date |
The user's birthdate, which can be used for age verification or personalization. | |
CurrentLanguage |
String |
The language currently selected by the user for their interface preferences. | |
CountryCode |
String |
The two-letter country code of the user's location, based on their country of residence. | |
CreatedAt |
Datetime |
The timestamp for when the user account was created, used for tracking account age and activity. | |
LastActivity |
Datetime |
The most recent date and time when the user was active, providing insight into user engagement. | |
Email |
String |
The user's email address, used for communication, notifications, and account recovery. | |
Enabled |
Bool |
Indicates whether the user account is currently active and able to perform actions. | |
IsAdmin |
Bool |
Indicates if the user has administrative privileges and can manage account settings and users. | |
IsGuest |
Bool |
Indicates if the user has guest access, typically with restricted permissions. | |
IsPending |
Bool |
Indicates whether the user account is pending approval or activation. | |
IsVerified |
Bool |
Indicates if the user has verified their email address, confirming their identity. | |
IsViewOnly |
Bool |
Indicates if the user has view-only access, meaning they can view but not modify data. | |
JoinDate |
Date |
The date when the user first joined the account, useful for understanding user tenure. | |
Location |
String |
The geographic location of the user, which may affect settings like time zone or language. | |
MobilePhone |
String |
The user's mobile phone number, used for notifications or secondary contact. | |
PhotoOriginal |
String |
The URL for the user's photo in its original size, typically used in larger display contexts. | |
PhotoSmall |
String |
The URL for the user's photo in a smaller size (150x150), suitable for smaller profile views. | |
PhotoThumb |
String |
The URL for the user's thumbnail photo (100x100), used in list views and smaller displays. | |
PhotoThumbSmall |
String |
The URL for the user's small thumbnail photo (50x50), typically used for icons or minimal views. | |
PhotoTiny |
String |
The URL for the user's tiny photo (30x30), used for extremely small icons or visual references. | |
TimeZoneIdentifier |
String |
The user's time zone identifier, used for scheduling and displaying time-related information. | |
Title |
String |
The user's job title or designation, providing context about their role within the organization. | |
Url |
String |
The URL to the user's profile page, typically used for linking to the user's detailed information. | |
UtcHoursDiff |
Int |
The difference in hours between the user's local time and UTC, used for adjusting timestamps and scheduling. | |
SignUpProductKind |
String |
The product or service that the user initially signed up for, helping to categorize user plans. | |
AccountFirstDayOfTheWeek |
String |
The day of the week (Sunday or Monday) designated as the start of the week for the account, affecting calendar views. | |
AccountId |
String |
The unique identifier for the account to which the user belongs, used to associate users with specific accounts. | |
AccountLogo |
String |
The URL for the account's logo, displayed in the UI to represent the account. | |
AccountName |
String |
The name of the account, used to identify the account in the system. | |
AccountPlanMaxUsers |
Int |
The maximum number of users allowed under the current account plan, indicating the plan's user capacity. | |
AccountPlanPeriod |
String |
The duration of the account's plan (for example, monthly, annually), which helps track billing cycles. | |
AccountPlanTier |
String |
The tier of the account's subscription plan (for example, Basic, Premium), defining the features available. | |
AccountPlanVersion |
Int |
The version number of the current plan, useful for tracking plan changes over time. | |
AccountShowTimelineWeekends |
Bool |
Indicates whether weekends are included in the account's timeline views. | |
AccountSlug |
String |
A URL-friendly version of the account name, typically used for the account's web address or identifier. | |
AccountTier |
String |
The account's subscription tier, which determines available features and limitations. | |
AccountCountryCode |
String |
The two-letter ISO 3166 country code for the account's registered country, helping to localize settings. | |
AccountSignUpProductKind |
String |
The product or service the account initially signed up for, which may determine the account's default settings. | |
AccountProducts |
String |
A list of active products or services associated with the account, showing the account's current offerings. | |
OutOfOfficeActive |
Bool |
Indicates whether the user's out-of-office status is currently active, affecting their availability. | |
OutOfOfficeDisableNotifications |
Bool |
Indicates if notifications are disabled while the user is out of office. | |
OutOfOfficeStartDate |
Date |
The date when the user's out-of-office status began, marking the start of their absence. | |
OutOfOfficeEndDate |
Date |
The date when the user's out-of-office status ends, marking the return to active status. | |
OutOfOfficeType |
String |
The type of out-of-office status, such as vacation or personal leave, used to specify the reason for absence. | |
NonActive |
Bool |
Indicates whether non-active users should be included in account queries, useful for generating reports on inactive users. |
Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Monday.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Monday, along with an indication of whether the procedure succeeded or failed.
Jitterbit Connector for Monday Stored Procedures
| Name | Description |
|---|---|
AddFileToColumn |
Attaches a file to a specific column value in a board, enhancing item detail management. |
AddFileToUpdate |
Uploads and associates a file with a specific update in Monday. |
BatchExtendTrialPeriod |
Extends the trial period of an application for multiple selected accounts simultaneously. |
ClearItemUpdates |
Clears updates associated with a specific item on a board. |
CreateDocBlock |
Creates a new content block within a document in Monday. |
CreateDocBoard |
Creates a new document within a board. |
CreateNotification |
Sends a new notification to users, detailing specific events or updates. |
DownloadAsset |
Downloads a file uploaded to Monday.com by specifying the corresponding asset ID. |
DuplicateBoard |
Creates a duplicate of an existing board, including its items, columns, and structure. |
DuplicateGroup |
Duplicates an existing group within a board. |
DuplicateItem |
Duplicates an item within a board, including its associated data. |
GetOAuthAccessToken |
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Monday. |
GetOAuthAuthorizationURL |
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process. |
LikeUpdate |
Adds a 'like' to a specific update, indicating approval or acknowledgment. |
MoveItemToBoard |
Moves an item from its current board to a different board, transferring all associated data. |
PinUpdate |
Pins a specific update, keeping it at the top of the update list for better visibility. |
RemoveMockAppSubscription |
Removes a mock app subscription for the current account, typically used for testing purposes. |
SetMockAppSubscription |
Sets a mock app subscription for the current account, enabling testing scenarios. |
UnpinUpdate |
Unpins a previously pinned update, allowing it to return to its chronological position. |
AddFileToColumn
Attaches a file to a specific column value in a board, enhancing item detail management.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ItemId |
String |
True | Specifies the unique identifier of the item to which the file will be attached. This should correspond to an existing item in the database. |
ColumnId |
String |
True | Specifies the unique identifier of the column where the file will be added. The column must exist and be associated with the specified item. |
FileName |
String |
False | Specifies the name of the file being uploaded. This is required when the file's content is provided via the Content input parameter. |
LocalPath |
String |
False | Specifies the local file path of the file to be uploaded. Use this when the file content is being uploaded from a local source. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
Indicates whether the file was successfully uploaded and attached to the specified column. |
Details |
String |
Provides additional information about the execution of the operation, such as warnings or errors encountered. |
AssetId |
String |
Returns the unique identifier (Asset ID) assigned to the uploaded file for future reference. |
AddFileToUpdate
Uploads and associates a file with a specific update in Monday.
Input
| Name | Type | Required | Description |
|---|---|---|---|
UpdateId |
String |
True | Specifies the unique identifier (ID) of the update to which the file should be added. |
FileName |
String |
False | Specifies the name of the file being added. This is required if 'Content' is provided. |
LocalPath |
String |
False | Specifies the local file path of the file to be uploaded. This is used when 'Content' is not provided. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
Indicates whether the file was successfully added to the update. |
Details |
String |
Provides additional details about the execution of the operation, such as errors or warnings. |
AssetId |
String |
Returns the unique identifier (ID) of the uploaded file for reference. |
BatchExtendTrialPeriod
Extends the trial period of an application for multiple selected accounts simultaneously.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AccountSlugs |
String |
True | A comma-separated list of account slugs (unique identifiers for accounts). Maximum allowed: 5. |
AppId |
String |
True | The unique identifier (ID) of the application associated with the trial period extension. |
PlanId |
String |
True | The unique identifier (ID) of the payment plan linked to the accounts for trial extension. |
DurationInDays |
Integer |
True | The number of days by which the trial period should be extended. Maximum allowable extension: 365 days. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
Indicates whether the batch operation to extend the trial period was successful. |
Reason |
String |
Provides a detailed reason for any error encountered during the batch operation. |
ClearItemUpdates
Clears updates associated with a specific item on a board.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ItemId |
String |
True | Specifies the unique identifier (ID) of the item for which updates are to be cleared. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
Returns a boolean indicating whether the operation to clear updates for the specified item was successful. |
Details |
String |
Provides additional details or messages about the execution of the operation, such as errors or warnings. |
ItemId |
String |
Returns the unique identifier (ID) of the item for which updates were cleared. |
CreateDocBlock
Creates a new content block within a document in Monday.
Input
| Name | Type | Required | Description |
|---|---|---|---|
DocId |
String |
True | Specifies the unique identifier (ID) of the document where the block will be created. |
AfterBlockId |
String |
False | Indicates the block ID after which the new block should be inserted. If not provided, the new block is inserted at the beginning of the document. |
ParentBlockId |
String |
False | Specifies the ID of the parent block under which the new block will be appended. Used for hierarchical block structures. |
Type |
String |
True | Defines the content type of the block, such as text, image, or table. The allowed values are board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget. |
Content |
String |
True | Specifies the content to include in the new block, such as text or other media. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
Indicates whether the block creation operation was successfully completed. |
Details |
String |
Provides additional details about the execution of the block creation operation, including error messages if applicable. |
DocumentBlockId |
String |
Returns the unique identifier (ID) of the newly created document block. |
CreateDocBoard
Creates a new document within a board.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ItemId |
String |
True | The unique identifier for the item being processed, used to reference the specific item in the database for the operation. |
ColumnId |
String |
True | The unique identifier for the column being manipulated, allowing the procedure to target a specific column within the table or schema. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A flag indicating whether the operation was successful. A value of true means the operation completed without errors, while false indicates failure. |
Details |
String |
A message providing additional information about the operation's execution, useful for debugging or understanding partial successes or failures. |
DocumentId |
String |
The unique identifier assigned to the document created or updated by the operation, linking it to the document management system or database. |
CreateNotification
Sends a new notification to users, detailing specific events or updates.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Text |
String |
True | The content of the notification message, providing the information or alert to be sent to the target. |
UserId |
String |
True | The unique identifier for the user initiating or receiving the notification, typically used to reference the user's account in the system. |
TargetId |
String |
True | The unique identifier for the target object of the notification, which can be a project, post, or another relevant entity. |
TargetType |
String |
True | The type of the target object (for example, Project or Post) that the notification pertains to, used to determine the context of the notification. The allowed values are Project, Post. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A flag indicating the outcome of the operation. A true value signifies that the notification was successfully sent or processed, while false indicates failure. |
Details |
String |
Additional information about the operation, such as an error message or context, useful for troubleshooting or understanding the result of the operation. |
NotificationId |
String |
The unique identifier for the notification that was created or processed, which can be used to reference or track the notification in the system. |
DownloadAsset
Downloads a file uploaded to Monday.com by specifying the corresponding asset ID.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AssetId |
String |
True | The unique identifier for the asset you wish to download, used to locate the asset in the system or database. |
LocalPath |
String |
False | The absolute file path where the asset will be saved on the local system. This must be a fully qualified path, including the filename and extension. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating the success of the operation. A true value indicates the asset download completed successfully, while false indicates an error occurred. |
Details |
String |
A detailed message offering more information about the operation's execution. This can provide context for success, partial success, or failure, useful for troubleshooting. |
FileData |
String |
The file data in base64 encoding, returned when both the LocalPath and FileStream inputs are not provided. This allows the file to be transmitted in a text-based format suitable for embedding or storage. |
DuplicateBoard
Creates a duplicate of an existing board, including its items, columns, and structure.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier of the board being duplicated, used to reference the source board in the operation. |
DuplicateType |
String |
True | Specifies the type of duplication being performed, which can determine the extent or method of the duplication (for example, full duplication, partial duplication). The allowed values are duplicate_board_with_structure, duplicate_board_with_pulses, duplicate_board_with_pulses_and_updates. |
BoardName |
String |
False | The name to be assigned to the new board being created during the duplication. If not provided, the system will automatically generate a name for the new board. |
WorkspaceId |
String |
False | The identifier of the workspace where the duplicated board should be placed. If omitted, the new board will be placed in the same workspace as the original board. |
FolderId |
String |
False | The identifier of the folder within the destination workspace for placing the new board. If not provided, the original board's folder is used as the default. |
KeepSubscribers |
Boolean |
False | Indicates whether the subscribers of the original board should be copied to the new board. By default, this is set to false, meaning subscribers are not duplicated. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating whether the duplication operation was completed successfully. A value of true means the operation was successful, and false means it failed. |
Details |
String |
A message that provides additional details about the result of the operation, which can be useful for debugging or understanding why a failure occurred. |
BoardId |
String |
The unique identifier of the new board created as a result of the duplication operation, which can be used for further actions or queries. |
DuplicateGroup
Duplicates an existing group within a board.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier of the board where the group will be added, used to target the specific board for the operation. |
GroupId |
String |
True | The unique identifier of the group being modified or created, allowing the operation to reference a specific group within the board. |
AddToTop |
Boolean |
False | A flag indicating whether the new group should be placed at the top of the board or list. If true, the group is added to the top; if false, it is added at the default position. |
GroupTitle |
String |
False | The title or name of the group being created or modified, used for identification and display purposes within the board. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating whether the operation was successful. True means the group was successfully added or modified; false indicates an error occurred. |
Details |
String |
A message providing additional information on the operation's outcome, helpful for understanding errors or confirming successful execution. |
GroupId |
String |
The unique identifier of the newly created or modified group, which can be used to reference the group in future operations. |
DuplicateItem
Duplicates an item within a board, including its associated data.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier for the board containing the item. |
WithUpdates |
Boolean |
False | A flag indicating whether the duplication should include any updates related to the item. Setting this flag ensures the item is copied along with its most recent changes. |
ItemId |
String |
True | The unique identifier for the item being duplicated. This is used to identify and replicate the specific item in the database. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value that indicates whether the duplication was successful. A value of true means the duplication was completed successfully, while false indicates an error occurred. |
Details |
String |
A text message that provides additional context or error details about the duplication process, useful for troubleshooting or confirming the behavior of the duplication. |
ItemId |
String |
The unique identifier of the item that was duplicated, returned to confirm the specific item that was successfully copied. |
GetOAuthAccessToken
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Monday.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AuthMode |
String |
False | The type of authentication mode to use. The allowed values are APP, WEB. The allowed values are APP, WEB. |
Verifier |
String |
False | The verifier token returned by Monday after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
Scope |
String |
False | The scope or permissions you are requesting. |
CallbackUrl |
String |
False | The URL the user will be redirected to after authorizing your application. |
State |
String |
False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
OAuthAccessToken |
String |
The authentication token returned from Monday. |
OAuthRefreshToken |
String |
A token that may be used to obtain a new access token. |
ExpiresIn |
String |
The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.
Input
| Name | Type | Required | Description |
|---|---|---|---|
CallbackUrl |
String |
False | The URL that Monday will return to after the user has authorized your app. |
Scope |
String |
False | The scope or permissions you are requesting. |
State |
String |
False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
URL |
String |
The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
LikeUpdate
Adds a 'like' to a specific update, indicating approval or acknowledgment.
Input
| Name | Type | Required | Description |
|---|---|---|---|
UpdateId |
String |
True | The unique identifier for the update operation, used to track and reference specific update actions being performed in the procedure. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A flag indicating whether the update operation was successful. A value of true means the update was successfully applied, while false indicates that an error occurred during execution. |
Details |
String |
A message providing additional context or error details regarding the update operation, offering insights into why the operation may have failed or succeeded. |
UpdateId |
String |
The identifier associated with the update, returned to confirm the completion of the update process and to allow tracking of the changes made. |
MoveItemToBoard
Moves an item from its current board to a different board, transferring all associated data.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier of the target board where items or groups will be moved or manipulated during the procedure. |
GroupId |
String |
True | The unique identifier of the target group within the board to which an item will be moved or associated. |
ItemId |
String |
True | The unique identifier of the item that is intended to be moved from one group or board to another. |
ColumnsMapping |
String |
False | A mapping that defines how the columns in the original board correspond to the columns in the target board, ensuring data consistency during the operation. |
SubitemsColumnsMapping |
String |
False | A mapping that defines how subitem columns in the original board correspond to the subitem columns in the target board, preserving the structure of subitems in the new board. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating the success or failure of the operation. A value of true confirms the procedure executed successfully, while false indicates an error or failure. |
Details |
String |
A message that provides additional context or information regarding the execution of the operation, such as errors or partial successes, to help with troubleshooting. |
ItemId |
String |
The unique identifier of the item after the operation, confirming its final status or location after being moved or modified. |
PinUpdate
Pins a specific update, keeping it at the top of the update list for better visibility.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Id |
String |
True | The unique identifier for the update operation, used to reference the specific update being applied in the system. |
ItemId |
String |
False | The unique identifier for the item being updated, allowing the procedure to target the specific item in the database. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating the success of the operation. True means the update was applied successfully, while false indicates a failure or error during execution. |
Details |
String |
A string containing additional information about the execution of the operation, useful for understanding any issues or providing insight into the outcome. |
Id |
String |
The unique identifier for the item after the update, confirming the item being affected and allowing any further interactions with it. |
PinnedToTopItemIds |
String |
A comma-separated list of item IDs representing the items that are pinned to the top as a result of the update. This helps track which items have been prioritized in the user interface. |
RemoveMockAppSubscription
Removes a mock app subscription for the current account, typically used for testing purposes.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AppId |
String |
True | The unique identifier for the app whose mocked subscription is being removed. This is used to locate the app in the system to ensure the correct subscription is targeted for removal. |
PartialSigningSecret |
String |
True | The last 10 characters of the app's signing secret. This partial secret is used for verification purposes to ensure the request is coming from a legitimate source. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A flag indicating whether the operation was successful. A value of true means the subscription removal was completed without issues, while false suggests there was an error during the process. |
Details |
String |
A message that provides additional information about the operation's execution, such as any encountered errors or steps that were skipped during the removal process. |
PlanId |
String |
The identifier for the mocked plan associated with the app. This value links to the specific plan being referenced for testing or simulation purposes. |
SetMockAppSubscription
Sets a mock app subscription for the current account, enabling testing scenarios.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AppId |
String |
True | The unique identifier of the application for which the subscription is being simulated, used to associate the mock subscription with the correct app in the system. |
PartialSigningSecret |
String |
True | The last 10 characters of the application's signing secret, used for verifying and authenticating the app during the subscription mock process. |
PlanId |
String |
False | The unique identifier of the plan to be simulated in the mock subscription, ensuring the correct plan is applied to the subscription. |
IsTrial |
Boolean |
False | A boolean flag indicating whether the subscription being mocked is a trial subscription, which may affect the pricing and renewal terms. |
RenewalDate |
Datetime |
False | The date when the subscription will be renewed. This field is essential for determining the timing of the next billing cycle or trial expiration. |
BillingPeriod |
String |
False | The frequency of billing for the subscription, either monthly or yearly, which dictates the payment schedule and the subscription's renewal cycle. |
PricingVersion |
Int |
False | The version of the pricing structure being applied to the mock subscription, allowing flexibility in testing different pricing models. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A flag indicating whether the subscription mock operation was completed successfully. A value of 'true' means the mock was successfully applied, and 'false' indicates an error or failure. |
Details |
String |
Additional context or messages regarding the outcome of the mock subscription operation, useful for debugging or understanding why an operation might have failed. |
PlanId |
String |
The plan ID that was assigned to the mocked subscription, reflecting the plan used in the simulated subscription setup. |
UnpinUpdate
Unpins a previously pinned update, allowing it to return to its chronological position.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Id |
String |
True | The unique identifier for the update operation, used to locate and apply changes to a specific update in the system. |
ItemId |
String |
False | The unique identifier for the item being updated, ensuring that the operation targets the correct item in the database. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating whether the update operation was successful. A value of true signifies that the update completed without errors, while false indicates a failure occurred. |
Details |
String |
A detailed message providing further information about the update operation, including reasons for failure or any important notes related to its execution. |
Id |
String |
The unique identifier assigned to the item after the update, confirming the specific item that was affected by the operation. |
PinnedToTopItemIds |
String |
A comma-separated list of item IDs that have been pinned to the top after the update, allowing easy reference to the items prioritized for visibility. |
AuditLog Data Model
In the AuditLog Data Model schema, the provider models activity logs that capture key user interactions, security events, and system changes within the Monday.com account as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Monday.com account are immediately reflected in the provider.
Views
The Views section, which lists read-only SQL tables, model data that is read-only and cannot be updated.
Views include:
| View | Description |
|---|---|
AuditLogs |
Retrieves the audit log events for a specific board, providing a detailed history of actions performed. |
Views
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Jitterbit Connector for Monday Views
| Name | Description |
|---|---|
AuditLogs |
Retrieves the audit log events for a specific board, providing a detailed history of actions performed. |
AuditLogs
Retrieves the audit log events for a specific board, providing a detailed history of actions performed.
View-Specific Information
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
For example, the following queries are processed server side.
Timestampsupports the '=, >, >=, <, <=' operators.UserIdsupports the=operator.IpAddresssupports the=operator.Eventsupports the '=, IN' operators.
All available values for the event filter are listed and explained below:
export-board-activity-log: Logs board Activity Log export by users.export-account-data: Logs account data export by admins.download-attachment: Logs file downloads by users.export-board: Logs board exports by users.export-dashboard: Logs dashboard exports by users.export-content-directory: Logs content directory exports by admins.login: Logs users' logins to the system.forgot-password: Logs users' "Forgot password?" clicks from the login page.logout: Logs users' logouts from the system.failed-login: Logs users' failed login attempts.user-reactivated: Logs users' reactivation by admins.user-deactivated: Logs users' deactivation by admins.user-details-deleted: Logs users' deletion by admins.user-invite: Logs users' invite from within the system.cancel-user-invite: Logs cancelled users' invite from within the system.user-role-change: Logs users' type change by admins.delete-board: Logs board deletion by users.delete-workspace: Logs workspace deletion by users.create-team: Logs team creation by users.delete-team: Logs team deletion by users.security-settings-change: Logs security settings changes by admins.board-broadcast-enabled: Logs board broadcast enablement by users.add-user-to-team: Logs users' addition to teams by users.remove-user-from-team: Logs users' removal from teams by users.add-user-to-product: Logs users' addition to Work OS Products.remove-user-from-product: Logs users' removal from Work OS Products.add-team-to-product: Logs teams' addition to Work OS Products.remove-team-from-product: Logs teams' removal from Work OS Products.api-complexity-breach-over-time: Logs API calls reaching the account limit.
The following queries are executed server-side:
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z'
SELECT * FROM AuditLogs WHERE Event IN ('export-board-activity-log', 'delete-board')
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z' AND Event = 'delete-board' AND UserId = 27 AND IpAddress = '123.123'
Columns
| Name | Type | References | Description |
|---|---|---|---|
Timestamp |
Datetime |
The date and time when the event occurred, recorded in a standard datetime format. | |
AccountId |
String |
The unique identifier of the account that initiated the event, used to track account-level activity. | |
UserId |
Int |
The unique identifier of the user who initiated the event, enabling user-specific auditing. | |
Event |
String |
The specific action or operation that was performed, such as 'Login', 'Update', or 'Delete'. The allowed values are export-board-activity-log, export-account-data, download-attachment, export-board, export-dashboard, export-content-directory, login, forgot-password, logout, failed-login, user-reactivated, user-deactivated, user-details-deleted, user-invite, cancel-user-invite, user-role-change, delete-board, delete-workspace, create-workspace, workspace-change-name, create-team, delete-team, approve-request-to-join-team, decline-request-to-join-team, security-settings-change, board-broadcast-enabled, add-user-to-team, remove-user-from-team, add-user-to-product, remove-user-from-product, add-team-to-product, remove-team-from-product, api-complexity-breach-over-time, account-role-permission-changed, workspace-role-permission-changed. | |
Slug |
String |
A human-readable identifier for the event, often used for categorization or reference. | |
IpAddress |
String |
The IP address from which the event was initiated, useful for tracking geographic location or security purposes. | |
UserAgent |
String |
The user agent string of the client initiating the event, providing details about the browser or application used. | |
ClientName |
String |
The name of the software client used to initiate the event, such as 'Chrome', 'Postman', or 'CustomApp'. | |
ClientVersion |
String |
The version number of the software client, used to identify the specific release or build of the application. | |
OsName |
String |
The name of the operating system on the client device, such as 'Windows', 'macOS', or 'Linux'. | |
OsVersion |
String |
The version number of the operating system running on the client device, such as 'Windows 10' or 'Ubuntu 22.04'. | |
DeviceName |
String |
The name of the device from which the event originated, such as 'John's Laptop' or 'Workstation01'. | |
DeviceType |
String |
The type of device used, such as 'Desktop', 'Laptop', 'Tablet', or 'Smartphone'. | |
ActivityMetadata |
String |
Additional metadata or contextual information related to the event, providing further details about the activity. |
Workspace Data Model
In the Workspace Data Model schema, the provider models the workspace-related data for managing projects as an easy-to-use SQL database. Live connectivity to these objects means that any changes to your Monday.com account are immediately reflected in the provider.
Tables
The Tables section, which details standard SQL tables, contain the tables that you may have access to in your Monday account. These tables can be modified.
Tables include:
| Table | Description |
|---|---|
Board |
Represents a workspace board containing items, columns, and other related data used for task management. |
BoardSubitems |
Represents a subitems board, storing nested items related to a primary board's items for more detailed task tracking. |
Stored Procedures
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including uploading files, creating columns in a board, and duplicating an item in a board.
Tables
The connector models the data in Monday as a list of tables in a relational database that can be queried using standard SQL statements.
Jitterbit Connector for Monday Tables
| Name | Description |
|---|---|
Board |
Represents a workspace board containing items, columns, and other related data used for task management. |
BoardSubitems |
Represents a subitems board, storing nested items related to a primary board's items for more detailed task tracking. |
Board
Represents a workspace board containing items, columns, and other related data used for task management.
Table-Specific Information
Note
This is an example board. Column names are retrieved dynamically from the API and may differ from the examples provided.
SELECT
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
Note that multiple filters are supported server-side (when they are all connected solely by AND logical operators or solely by OR logical operators).
ItemIdsupports the '=', 'IN', operators.Itemsupports the '=', 'IN', '!=', 'NOT IN', 'CONTAINS' operators.Textsupports the '=', 'IN', '!=', 'NOT IN', 'CONTAINS' operators.Checksupports the '=', '!=', 'IS TRUE', 'IS FALSE', 'IS NOT TRUE', 'IS NOT FALSE' operators.BoardRelationDisplayValuesupports the '=', '!=' operators when comparing with an empty string.BoardRelationLinkedItemIdssupports the '=', '!=' operators when comparing with an empty string.TagsTextsupports the '=', '!=' operators when comparing with an empty string.TagsIdssupports the '=', '!=' operators when comparing with an empty string.CountryCodesupports the '=', 'IN', '!=', 'NOT IN', 'IS NULL', 'IS NOT NULL' operators.CountryNamesupports the '=', 'CONTAINS', 'IS NULL', 'IS NOT NULL' operators.DependentOnDisplayValuesupports the '=', '!=' operators when comparing with a string containing only one pair of square brackets '[]'.DependentOnLinkedItemsIdssupports the '=', '!=' operators when comparing with an empty string.EmailLabelsupports the '=', 'IN', '!=', 'NOT IN', 'CONTAINS', 'IS NULL', 'IS NOT NULL' operators.Hoursupports the '=', 'IN', '!=', 'NOT IN' operators for time values between 04:00 inclusive and 23:59 inclusive, and the 'IS NULL', 'IS NOT NULL' operators.Datesupports the '=', 'IN', '!=', 'NOT IN', '>', '>=', '<', '<=', 'IS NULL', 'IS NOT NULL' operators.Datetimesupports the 'IS NULL', 'IS NOT NULL' operators.TimelineFromsupports the 'IS NULL', 'IS NOT NULL' operators.TimelineTosupports the 'IS NULL', 'IS NOT NULL' operators.WeekStartDatesupports the 'IS NULL', 'IS NOT NULL' operators.WeekEndDatesupports the 'IS NULL', 'IS NOT NULL' operators.LinkUrlTextsupports the '=', 'IN', '!=', 'NOT IN', 'CONTAINS', 'IS NULL', 'IS NOT NULL' operators.Numberssupports the '=', '!=', 'IN', 'NOT IN', '>', '>=', '<', '<=', 'IS NULL', 'IS NOT NULL' operators.PeopleTextsupports the '=', '!=' operators when comparing with an empty string.PeopleValuesupports the 'IS NULL', 'IS NOT NULL' operators.DropdownTextsupports the '=', '!=' operators when comparing with an empty string.DropdownValuesupports the 'IS NULL', 'IS NOT NULL' operators.PhoneCountryShortNamesupports the '=', 'IN', '!=', 'NOT IN', 'IS NULL', 'IS NOT NULL' operators.Phonesupports the '=', 'CONTAINS', 'IS NULL', 'IS NOT NULL' operators.Ratingsupports the '=', 'IN', '!=', 'NOT IN', 'IS NULL', 'IS NOT NULL' operators.StatusIndexsupports the '=', 'IN', '!=', 'NOT IN', 'IS NULL', 'IS NOT NULL' operators.StatusLabelsupports the '=', 'IN', '!=', 'NOT IN', 'IS NULL', 'IS NOT NULL' operators.LastUpdatedsupports the '=', 'IN', '!=', 'NOT IN' operators.TimeTrackingRunningsupports the '=', '!=', 'IS TRUE', 'IS FALSE', 'IS NOT TRUE', 'IS NOT FALSE' operators.VoteVoterIdssupports the '=', '!=' operators when comparing with an empty string.
The following columns are sorted server-side when including an ORDER BY clause:
CreatedAtsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.UpdatedAtsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.Itemsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.BoardRelationDisplayValuesupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.Checksupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.ColorPickerColorsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.CountryNamesupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.DependentOnDisplayValuesupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.EmailLabelsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.Numberssupports 'ASC NULLS LAST', 'DESC NULLS FIRST'.LinkUrlTextsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.Phonesupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.Ratingsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.TimeTrackingDurationsupports 'ASC NULLS FIRST', 'DESC NULLS LAST'.
The following queries are processed server side:
SELECT * FROM Board
SELECT * FROM Board WHERE ItemId = '5465844671'
SELECT * FROM Board WHERE ItemId IN ('5465844671','5465844679')
SELECT * FROM Board WHERE Item = 'Item 2'
SELECT * FROM Board WHERE Item != 'Item 2'
SELECT * FROM Board WHERE Item NOT IN ('Item 1','Item 2')
SELECT * FROM Board WHERE Item Contains 'Item'
SELECT * FROM Board WHERE CONTAINS (Item,'Item')
SELECT * FROM Board WHERE NOT CONTAINS (Item,'Item')
SELECT * FROM Board WHERE Check = True
SELECT * FROM Board WHERE Check != True
SELECT * FROM Board WHERE Check IS TRUE
SELECT * FROM Board WHERE Check IS NOT TRUE
SELECT * FROM Board WHERE Check = False
SELECT * FROM Board WHERE Check != False
SELECT * FROM Board WHERE Check IS FALSE
SELECT * FROM Board WHERE Check IS NOT FALSE
SELECT * FROM Board WHERE BoardRelationLinkedItemIds = ''
SELECT * FROM Board WHERE BoardRelationLinkedItemIds != ''
SELECT * FROM Board WHERE BoardRelationDisplayValue = ''
SELECT * FROM Board WHERE BoardRelationDisplayValue != ''
SELECT * FROM Board WHERE CountryCode = 'US'
SELECT * FROM Board WHERE CountryCode != 'US'
SELECT * FROM Board WHERE CountryCode IN ('US','UK')
SELECT * FROM Board WHERE CountryCode NOT IN ('US','UK')
SELECT * FROM Board WHERE CountryCode IS NULL
SELECT * FROM Board WHERE CountryCode IS NOT NULL
SELECT * FROM Board WHERE DependentOnDisplayValue = '[]'
SELECT * FROM Board WHERE DependentOnDisplayValue != '[]'
SELECT * FROM Board WHERE Hour='07:32:00'
SELECT * FROM Board WHERE Numbers IN (12, 55)
SELECT * FROM Board WHERE Numbers = 10
SELECT * FROM Board WHERE Numbers != 10
SELECT * FROM Board WHERE Numbers > 10
SELECT * FROM Board WHERE Numbers >= 10
SELECT * FROM Board WHERE Numbers < 10
SELECT * FROM Board WHERE Numbers <= 10
SELECT * FROM Board WHERE Text = 'test' AND Numbers = 10
SELECT * FROM Board WHERE Text = 'test' OR Numbers = 10
SELECT * FROM Board ORDER BY Item
SELECT * FROM Board ORDER BY CreatedAt
SELECT * FROM Board ORDER BY UpdatedAt
SELECT * FROM Board ORDER BY Numbers ASC NULLS LAST
INSERT
The following inputs can be used in INSERT statements:
GroupId, ItemName, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
INSERT INTO Board (Item,GroupId,Check) VALUES ('Test','topics',true)
INSERT INTO Board (Item,GroupId,CountryCode,CountryName) VALUES ('Test','topics','US','United States')
INSERT INTO Board (Item,GroupId,Date) VALUES ('Test','topics','2023-11-16')
INSERT INTO Board (Item,GroupId,Datetime) VALUES ('Test','topics','2023-11-16 09:00:00.0-05:00')
INSERT INTO Board (Item,GroupId,DependentLinkedItemsIds) VALUES ('Test','topics','[5561036960, 5561037791]')
INSERT INTO Board (Item,GroupId,DropdownText) VALUES ('Test','topics','label1,label2')
INSERT INTO Board (Item,GroupId,DropdownText,CreateLabelsIfMissing) VALUES ('Test','topics','label3,label4','true')
INSERT INTO Board (Item,GroupId,DropdownValue) VALUES ('Test','topics','{"ids":[1,2]}')
INSERT INTO Board (Item,GroupId,Email,EmailLabel) VALUES ('Test','topics','test@mail.com','Mail')
INSERT INTO Board (Item,GroupId,Hour) VALUES ('Test','topics','09:00:00')
INSERT INTO Board (Item,GroupId,LinkUrl,LinkUrlText) VALUES ('Test','topics','https://www.test.com/', 'TestLink')
INSERT INTO Board (Item,GroupId,LocationLat,LocationLng,LocationAddress) VALUES ('Test','topics',29.9772962,31.1324955,'Giza Pyramid Complex')
INSERT INTO Board (Item,GroupId,LongText) VALUES ('Test','topics','TestText')
INSERT INTO Board (Item,GroupId,Numbers) VALUES ('Test','topics','-10')
INSERT INTO Board (Item,GroupId,PeopleValue) VALUES ('Test','topics','{"personsAndTeams":[{"id":51688059,"kind":"person"},{"id":51085546,"kind":"person"}]}')
INSERT INTO Board (Item,GroupId,PhoneCountryShortName,Phone) VALUES ('Test','topics','US','12345678900')
INSERT INTO Board (Item,GroupId,Rating) VALUES ('Test','topics','5')
INSERT INTO Board (Item,GroupId,StatusIndex) VALUES ('Test','topics','2')
INSERT INTO Board (Item,GroupId,StatusIndex,StatusLabel,CreateLabelsIfMissing) VALUES ('Test','topics','15','NewLabel','true')
INSERT INTO Board (Item,GroupId,StatusLabel) VALUES ('Test','topics','Working on it')
INSERT INTO Board (Item,GroupId,TagsIds) VALUES ('Test','topics','[20826704,20826705]')
INSERT INTO Board (Item,GroupId,BoardLinkedItemIds) VALUES ('Test','topics','[5561037791,5561036960]')
INSERT INTO Board (Item,GroupId,Text) VALUES ('Test','topics','TestText')
INSERT INTO Board (Item,GroupId,TimelineFrom,TimelineTo) VALUES ('Test','topics','2023-11-01','2023-12-04')
INSERT INTO Board (Item,GroupId,WeekStartDate,WeekEndDate) VALUES ('Test','topics','2023-11-05','2023-11-11')
INSERT INTO Board (Item,GroupId,World_Clock) VALUES ('Test','topics','Africa/Algiers')
INSERT INTO Board (Item, RelativeTo, PositionRelativeMethod) VALUES ('new', '7161109809', 'before_at')
UPDATE
The following inputs can be used in UPDATE statements:
CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, ItemName, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock, GroupId, State
Note that GroupId, State and column values cannot be updated in the same statement.
Also note that certain types require specifying all related columns to update the object's value (this includes Email, Link, Location, Phone, Timeline, and Week).
UPDATE Board SET GroupId = 'new_group' WHERE ItemId = '5562458608'
UPDATE Board SET State = 'archived' WHERE ItemId = '5562458608'
UPDATE Board SET ItemName = 'Test' WHERE ItemId = '5561890829'
UPDATE Board SET Check = false WHERE ItemId = '5561890829'
UPDATE Board SET CountryCode = 'US', CountryName = 'United States' WHERE ItemId = '5561890829'
UPDATE Board SET CountryCode = NULL, CountryName = NULL WHERE ItemId = '5561890829'
UPDATE Board SET Date = '2023-11-25' WHERE ItemId = '5561890829'
UPDATE Board SET Date = NULL WHERE ItemId = '5561890829'
UPDATE Board SET Datetime = '2023-11-23 04:00:00.0' WHERE ItemId = '5561890829'
UPDATE Board SET DependentLinkedItemsIds = '[5562459384, 5562458774]' WHERE ItemId = '5561890829'
UPDATE Board SET DependentLinkedItemsIds = NULL WHERE ItemId = '5561890829'
UPDATE Board SET DropdownText = 'Label1,Label2' WHERE ItemId = '5561890829'
UPDATE Board SET DropdownText = 'Label6,Label7',CreateLabelsIfMissing = 'true' WHERE ItemId = '5561890829'
UPDATE Board SET DropdownValue = '{"ids":[2,3]}' WHERE ItemId = '5561890829'
UPDATE Board SET DropdownValue = NULL WHERE ItemId = '5561890829'
UPDATE Board SET Email = 'another@email.com',EmailLabel = 'NewMail' WHERE ItemId = '5561890829'
UPDATE Board SET Email = NULL, EmailLabel = NULL WHERE ItemId = '5561890829'
UPDATE Board SET Hour = '21:00:00' WHERE ItemId = '5561890829'
UPDATE Board SET Hour = NULL WHERE ItemId = '5561890829'
UPDATE Board SET LinkUrl = 'https://www.test.com', LinkUrlText = 'TestText' WHERE ItemId = '5561890829'
UPDATE Board SET LinkUrl = NULL, LinkUrlText = NULL WHERE ItemId = '5561890829'
UPDATE Board SET LocationAddress = NULL, LocationLat = NULL, LocationLng = NULL WHERE ItemId = '5561890829'
UPDATE Board SET LocationLat = '82', LocationLng = '135', LocationAddress = 'TestLocation' WHERE ItemId = '5561890829'
UPDATE Board SET LongText = 'changed text' WHERE ItemId = '5561890829'
UPDATE Board SET LongText = NULL WHERE ItemId = '5561890829'
UPDATE Board SET Numbers = 10 WHERE ItemId = '5561890829'
UPDATE Board SET Numbers = NULL WHERE ItemId = '5561890829'
UPDATE Board SET PeopleValue = '{"personsAndTeams":[{"id":51085546,"kind":"person"},{"id":961021,"kind":"team"}]}' WHERE ItemId = '5561890829'
UPDATE Board SET PeopleValue = NULL WHERE ItemId = '5561890829'
UPDATE Board SET Phone = NULL, PhoneCountryShortName = NULL WHERE ItemId = '5561890829'
UPDATE Board SET PhoneCountryShortName = 'US', Phone = '16102347959' WHERE ItemId = '5561890829'
UPDATE Board SET Rating = '1' WHERE ItemId = '5561890829'
UPDATE Board SET Rating = NULL WHERE ItemId = '5561890829'
UPDATE Board SET StatusIndex = '2' WHERE ItemId = '5561890829'
UPDATE Board SET StatusIndex = NULL WHERE ItemId = '5561890829'
UPDATE Board SET StatusLabel = 'NewLabel', StatusIndex = '159', CreateLabelsIfMissing = 'true' WHERE ItemId = '5561890829'
UPDATE Board SET StatusLabel = 'Working on it' WHERE ItemId = '5561890829'
UPDATE Board SET TagsIds = '[20826705,20833783]' WHERE ItemId = '5561890829'
UPDATE Board SET TagsIds = NULL WHERE ItemId = '5561890829'
UPDATE Board SET BoardLinkedItemIds = NULL WHERE ItemId = '5561890829'
UPDATE Board SET BoardLinkedItemIds = '[5562459384, 5561890829, 5562458774]' WHERE ItemId = '5561890829'
UPDATE Board SET Text = 'changedText' WHERE ItemId = '5561890829'
UPDATE Board SET Text = NULL WHERE ItemId = '5561890829'
UPDATE Board SET TimelineFrom = '2023-01-01', TimelineTo = '2023-10-10' WHERE ItemId = '5561890829'
UPDATE Board SET TimelineFrom = NULL, TimelineTo = NULL WHERE ItemId = '5561890829'
UPDATE Board SET WeekStartDate = '2023-11-13', WeekEndDate = '2023-11-19' WHERE ItemId = '5561890829'
UPDATE Board SET WeekStartDate = NULL, WeekEndDate = NULL WHERE ItemId = '5561890829'
UPDATE Board SET WorldClock = 'America/New York' WHERE ItemId = '5561890829'
UPDATE Board SET WorldClock = NULL WHERE ItemId = '5561890829'
DELETE
You can delete items by specifying the ItemId.
DELETE FROM Board WHERE ItemId = '5561890829'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
ItemId [KEY] |
String |
False | The unique identifier for each item in the system, used to reference and distinguish items across the database. | |
CreatorId |
String |
False | The unique identifier of the user who created the item, allowing tracking of item origin. | |
CreatedAt |
Datetime |
False | The date and time when the item was created in the system, useful for audit and tracking item age. | |
UpdatedAt |
Datetime |
False | The date and time of the most recent update made to the item, enabling tracking of changes over time. | |
State |
String |
False | The current state of the item, indicating whether it is active, archived, deleted, or in any other defined state. | |
RelativeLink |
String |
False | The relative URL path pointing to the item's location within the system or application. | |
ItemEmail |
String |
False | The email address associated with the item, typically used for notifications or communication. | |
Url |
String |
False | The full URL link pointing to the item or related resource, allowing direct access to the item online. | |
AssetsIds |
String |
False | A comma-separated list of unique identifiers for the assets or files associated with the item, facilitating easy referencing. | |
GroupId |
String |
False | The identifier of the group to which this item belongs, used to categorize and manage items in groups. | |
GroupTitle |
String |
False | The title or name of the group containing the item, offering contextual categorization. | |
Item |
String |
False | The name of the item, typically used as a label or title within the system. | |
BoardRelationDisplayValue |
String |
False | A string representing the names of linked items, separated by commas, to visualize their relationship. | |
BoardRelationLinkedItemIds |
String |
False | A comma-separated list of item IDs that are linked to the current item, allowing for reference to related data. | |
ButtonLabel |
String |
False | The label or text displayed on the button associated with the item, providing a user-friendly description of the button's function. | |
ButtonColor |
String |
False | The color of the button in hexadecimal format, used to define the button's visual style. | |
ButtonValue |
String |
False | The value associated with the button, typically represented in JSON format for structured data processing. | |
Check |
Bool |
False | The boolean value indicating whether a condition is true (checked) or false (unchecked), commonly used in forms. | |
ColorPickerColor |
String |
False | The selected color in hexadecimal format, used to specify color preferences in the item. | |
ColorPickerValue |
String |
False | The color value in JSON format, representing the full color configuration for the item. | |
CountryCode |
String |
False | The two-letter ISO code representing the country of the item or associated data. | |
CountryName |
String |
False | The full name of the country associated with the item, providing clarity for localization. | |
DateIcon |
String |
False | A string representing the icon selected for the date, used for visual representation of date fields. | |
Date |
Date |
False | The date value for the item, typically used to represent important events or milestones. | |
Datetime |
Datetime |
False | The datetime value associated with the item, used for tracking both date and time of events. | |
DependencyDisplayValue |
String |
False | A string listing the names of items upon which this task depends, enabling visual representation of task dependencies. | |
DependencyLinkedItemsIds |
String |
False | A list of item IDs representing the tasks or items that this task depends on, ensuring task scheduling accuracy. | |
DocFileId |
String |
False | The unique identifier for the document file associated with the item, used for managing document-related data. | |
DocFileCreatorId |
String |
False | The ID of the user who created the document file, useful for tracking document ownership and history. | |
DocFileObjectId |
String |
False | The identifier of the object or board related to the document file, linking the file to its contextual data. | |
DocFileUrl |
String |
False | The URL where the document file can be accessed or downloaded, providing direct access to the document. | |
DocFileDocId |
String |
False | The unique document identifier associated with the file, used for cross-referencing within document management systems. | |
DropdownText |
String |
False | The text value selected from a dropdown list, representing the user's choice in a user-friendly format. | |
DropdownValue |
String |
False | The value associated with the dropdown selection, represented in JSON format for structured data. | |
Email |
String |
False | The email address associated with the column, typically used for notifications or communications related to the item. | |
EmailLabel |
String |
False | The label or description of the email field, which may be the same as the email address if no label was entered. | |
FileText |
String |
False | The text value of the file column, used for storing textual content related to the file. | |
FileValue |
String |
False | The value of the file column in JSON format, allowing structured representation of file data. | |
Hour |
Time |
False | The time value associated with the item, representing a specific hour or time in a day. | |
IntegrationIssueId |
String |
False | The unique identifier for the integration issue, used for tracking issues in third-party integrations. | |
IntegrationEntityId |
String |
False | The unique identifier for the entity involved in the integration, allowing for efficient tracking and management. | |
IntegrationIssueApiUrl |
String |
False | The API URL where details about the integration issue can be accessed, facilitating debugging and resolution. | |
IntegrationValue |
String |
False | The value in JSON format representing the data or configuration related to the integration issue. | |
LastUpdated |
String |
False | The identifier of the user who last updated the item, allowing for tracking of who made the most recent changes. | |
LinkUrl |
String |
False | The URL link associated with the item, used to direct users to external resources or related items. | |
LinkUrlText |
String |
False | The display text for the link, providing context or description for users about the link's destination. | |
LocationLat |
Double |
False | The latitude coordinate of the item's location, used for mapping and geospatial purposes. | |
LocationLng |
Double |
False | The longitude coordinate of the item's location, used in conjunction with latitude for accurate geolocation. | |
LocationPlaceId |
String |
False | The place ID associated with the item's location, used for precise location identification in mapping systems. | |
LocationAddress |
String |
False | The full address of the item's location, providing complete details for geolocation purposes. | |
LocationCity |
String |
False | The city in which the item is located, used to specify its geographic location. | |
LocationCityShort |
String |
False | A shorthand version of the city's name, typically used for space-saving purposes. | |
LocationCountry |
String |
False | The country where the item is located, providing regional context for the item. | |
LocationCountryShort |
String |
False | A shortened version of the country's name, typically using its two-letter ISO code. | |
LocationStreet |
String |
False | The street address of the item's location, giving a precise physical location. | |
LocationStreetNumber |
String |
False | The street number of the building, giving additional detail to the street address. | |
LocationStreetNumberShort |
String |
False | A shorthand version of the building number, typically used in forms with limited space. | |
LocationStreetShort |
String |
False | A shortened version of the street name, used when space is limited or for abbreviated addresses. | |
LongText |
String |
False | A field for storing longer text, typically used for descriptions, notes, or additional information. | |
MirrorDisplayValue |
String |
False | The display value for items mirrored from other sources, typically representing the original data. | |
MirroredItems |
String |
False | A list of items that are mirrored, representing items whose data is replicated across different locations. | |
Numbers |
Double |
False | A numeric value representing any relevant quantity or measurement associated with the item. | |
PeopleText |
String |
False | The text value for the people column, used for storing names or descriptions of people related to the item. | |
PeopleValue |
String |
False | The value of the people column in JSON format, representing structured data about people. | |
PhoneCountryShortName |
String |
False | The ISO-2 country code representing the country of the phone number. | |
Phone |
String |
False | The phone number associated with the item, used for contact purposes. | |
Rating |
Int |
False | An integer representing the rating assigned to the item, typically used in review or feedback systems. | |
StatusIndex |
Int |
False | The index number of the status in the board, allowing for sorting and managing item statuses. | |
StatusIsDone |
Bool |
False | A boolean indicating whether the status of the item is marked as complete or not. | |
StatusLabel |
String |
False | The label or name of the status, providing a user-friendly identifier for the item's state. | |
StatusUpdateId |
String |
False | The unique identifier for the status update, allowing for tracking of changes to the item's status. | |
StatusLabelStyleColor |
String |
False | The hexadecimal color value representing the style of the status label, used to define the label's visual color. | |
StatusLabelStyleBorder |
String |
False | The hexadecimal color value representing the style of the status label's border, used for visual distinction. | |
TagsText |
String |
False | The textual representation of the tags associated with the item, providing an easy-to-read list of tags. | |
TagsIds |
String |
False | A list of tag IDs associated with the item, allowing for filtering and categorization based on tags. | |
Text |
String |
False | The text value of the item, typically used for storing descriptions, titles, or other relevant textual data. | |
TimeTrackingRunning |
Bool |
False | A boolean value indicating whether the time tracker associated with the item is currently running. | |
TimeTrackingStartedAt |
Datetime |
False | The timestamp of when the time tracking was started, providing a reference for when the activity began. | |
TimeTrackingDuration |
Int |
False | The total duration in seconds for which the time tracker has been running. | |
TimelineFrom |
Date |
False | The start date for the timeline, used to specify when the project or task begins. | |
TimelineTo |
Date |
False | The end date for the timeline, marking the completion or due date for the project or task. | |
TimelineVisualizationType |
String |
False | The type of visualization to use for the timeline, defining how the timeline data is presented to the user. | |
VoteCount |
Int |
False | The total number of votes cast for the item, used in voting or polling scenarios. | |
VoterIds |
String |
False | A list of user IDs who have voted on the item, used to track voter participation. | |
WeekStartDate |
Date |
False | The start date for the week, typically used for scheduling or time tracking purposes. | |
WeekEndDate |
Date |
False | The end date for the week, marking the conclusion of the weekly period. | |
WorldClock |
String |
False | The timezone or world clock setting used to display the item's time in the correct time zone. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
RelativeTo |
String |
The item to which the current item is relative, used for positioning items next to each other in a layout. |
PositionRelativeMethod |
String |
The method used to determine the item's position relative to another item, either before or after it. |
CreateLabelsIfMissing |
Bool |
A pseudocolumn that indicates whether new labels for status or dropdown fields should be created if missing, requiring board structure modification permissions. |
BoardSubitems
Represents a subitems board, storing nested items related to a primary board's items for more detailed task tracking.
Table-Specific Information
The connector uses the Monday API to process some of the filters. The connector processes other filters client-side within the connector.
SELECT
Note
'Subitems'-type tables support the same server-side filters and CUD operations as the main board.
SELECT C.ItemId AS ChildId, C.Subitem AS ChildName, P.ItemId AS ParentId, P.Item AS ParentName FROM BoardSubitems C INNER JOIN Board P ON C.ParentItemId = P.ItemId
INSERT
The following inputs can be used in INSERT statements:
ParentItemId, GroupId, ItemName, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
INSERT INTO BoardSubitems (ParentItemId, Subitem) VALUES ('5562458608','NewSubItem')
UPDATE
The following inputs can be used in UPDATE statements:
CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, ItemName, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
UPDATE BoardSubitems SET WorldClock = 'Europe/Amsterdam' WHERE ItemId = '5573109452'
DELETE
You can delete entries by specifying the ItemId.
DELETE FROM BoardSubItems WHERE ItemId = '5561890829'
Columns
| Name | Type | ReadOnly | References | Description |
|---|---|---|---|---|
ItemId [KEY] |
String |
False | The unique identifier for each item in the system, used for referencing and querying specific items. | |
ParentItemId |
String |
False | The unique identifier of the parent item, indicating the hierarchical relationship between items. | |
CreatorId |
String |
False | The unique identifier of the user who created the item, helpful for tracking ownership. | |
CreatedAt |
Datetime |
False | The timestamp representing when the item was created in the system. | |
UpdatedAt |
Datetime |
False | The timestamp representing the last time the item was updated, useful for tracking changes. | |
State |
String |
False | Represents the current status of the item, such as 'all', 'active', 'archived', or 'deleted'. | |
RelativeLink |
String |
False | The relative URL or path to the item, used for navigation or linking within the system. | |
ItemEmail |
String |
False | The email address associated with the item, if applicable, typically used for notifications or communications. | |
Url |
String |
False | The full URL link to the item, providing access to the item’s page or resource. | |
AssetsIds |
String |
False | A comma-separated list of unique identifiers for the assets or files associated with the item. | |
GroupId |
String |
False | The identifier of the group to which the item belongs, used to organize and categorize items. | |
GroupTitle |
String |
False | The title or name of the group that contains this item, providing context for grouping and organization. | |
Subitem |
String |
False | The name or description of the subitem, typically used in hierarchical or dependent structures. | |
OwnerText |
String |
False | The textual value of the column, providing a human-readable form of the data stored in that column. | |
OwnerValue |
String |
False | The value of the column represented in JSON format, capturing complex data in a structured format. | |
StatusIndex |
Int |
False | The index position of the current status in the board, helping to identify its order in a list of statuses. | |
StatusIsDone |
Bool |
False | Indicates whether the item is marked as 'done' in its current status, used for task tracking. | |
StatusLabel |
String |
False | The label or name assigned to the status, which is visible to users to indicate the item’s progress. | |
StatusUpdateId |
String |
False | The unique identifier for any updates linked to the item’s current status, useful for tracking changes. | |
StatusLabelStyleColor |
String |
False | The color style applied to the status label, represented as a hex value to visually indicate the status. | |
StatusLabelStyleBorder |
String |
False | The border color style applied to the status label, represented as a hex value, enhancing visual distinction. | |
DateIcon |
String |
False | The icon associated with the date field, represented as a string, used for visual reference or selection. | |
Date |
Date |
False | The date value stored in the column, used to track specific dates associated with the item. | |
Datetime |
Datetime |
False | The datetime value stored in the column, capturing both the date and time of an event or action. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
|---|---|---|
CreateLabelsIfMissing |
Bool |
A pseudocolumn that triggers the creation of missing status or dropdown labels, requiring proper permissions to modify the board structure. |
Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Monday.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Monday, along with an indication of whether the procedure succeeded or failed.
Jitterbit Connector for Monday Stored Procedures
| Name | Description |
|---|---|
AddFileToColumn |
Attaches a file to a specific column value within a board, enhancing item management. |
AddFileToUpdate |
Uploads and associates a file with a specific update, providing additional context. |
BatchExtendTrialPeriod |
Extends the trial period for an application across multiple selected accounts, allowing for continued testing or evaluation. |
ChangeColumnMetadata |
Updates the metadata or properties of a specific column in a board, such as its type or settings. |
ClearItemUpdates |
Removes all updates associated with a specific item on a board, clearing its update history. |
CreateColumn |
Creates a new column in a board, allowing for customized data fields. |
CreateDocBlock |
Adds a new content block to a document associated with a workspace. |
CreateDocBoard |
Creates a new document within a workspace board. |
CreateNotification |
Generates a new notification for users about specific events or updates. |
DeleteColumn |
Deletes an existing column from a board, removing its associated data. |
DownloadAsset |
Downloads a file that was uploaded to Monday.com by specifying the asset ID. |
DuplicateBoard |
Creates an exact copy of an existing board, including all items, columns, and structures. |
DuplicateGroup |
Duplicates an existing group of items within a board. |
DuplicateItem |
Duplicates an item within a board, including its related data and structure. |
GetOAuthAccessToken |
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Monday. |
GetOAuthAuthorizationURL |
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process. |
LikeUpdate |
Registers a 'like' on a specific update, providing a quick way to acknowledge or endorse updates. |
MoveItemToBoard |
Moves a specific item from one board to another, preserving its associated data. |
PinUpdate |
Pins an update to the top of the feed for better visibility and priority. |
RemoveMockAppSubscription |
Removes a mock application subscription associated with the current account. |
SetMockAppSubscription |
Sets a mock application subscription for the current account, simulating app usage. |
UnpinUpdate |
Unpins a previously pinned update, returning it to the standard feed order. |
AddFileToColumn
Attaches a file to a specific column value within a board, enhancing item management.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ItemId |
String |
True | The unique identifier for the item to which the file is being added. This is used to associate the file with a specific item in the system. |
ColumnId |
String |
True | The unique identifier for the column in which the file will be added. This determines the location within the item's structure where the file will be placed. |
FileName |
String |
False | The name of the file being uploaded. This parameter is required when the 'Content' field is provided and allows the system to associate a name with the uploaded file. |
LocalPath |
String |
False | The local file path to the file being uploaded. If specified, this provides the path to the file on the user's machine that will be uploaded to the system. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating the outcome of the operation. A true value means the file upload was successful, while false indicates an error occurred. |
Details |
String |
Additional information about the result of the operation. This can include error messages, partial success details, or other relevant context. |
AssetId |
String |
The unique identifier assigned to the file once it is uploaded. This ID is used to reference the uploaded file in subsequent operations. |
AddFileToUpdate
Uploads and associates a file with a specific update, providing additional context.
Input
| Name | Type | Required | Description |
|---|---|---|---|
UpdateId |
String |
True | The unique identifier of the update operation where the file should be added. This allows the procedure to associate the file with a specific update record in the system. |
FileName |
String |
False | The name of the file being uploaded. This is required when the 'Content' parameter is used to specify the file's contents, ensuring the file is properly named in the database. |
LocalPath |
String |
False | The local file path where the file is stored on the system. This is used when the file needs to be uploaded from a specific location on the server. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating whether the file upload operation completed successfully. 'True' means the operation was successful, while 'False' indicates there was an error. |
Details |
String |
A message containing additional details or feedback about the file upload operation, which can be useful for debugging or confirming the success of the process. |
AssetId |
String |
The unique identifier assigned to the uploaded file. This ID can be used to reference the file in subsequent operations or to retrieve it from the system. |
BatchExtendTrialPeriod
Extends the trial period for an application across multiple selected accounts, allowing for continued testing or evaluation.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AccountSlugs |
String |
True | A comma-separated list of up to five account slugs that are being processed in the current operation, used to identify and filter accounts. |
AppId |
String |
True | The unique identifier for the application within the system, used to target the specific application for the current operation or query. |
PlanId |
String |
True | The unique identifier for the payment plan, which determines the pricing and features associated with the current operation. |
DurationInDays |
Integer |
True | The number of days to extend the trial period for the specified accounts. The value can range from 1 to 365 days. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
Indicates whether the batch operation was successful. A value of true means all tasks within the operation completed successfully, while false indicates an error occurred. |
Reason |
String |
Provides an explanation for any failure or error that occurred during the operation, useful for troubleshooting or understanding the cause of the issue. |
ChangeColumnMetadata
Updates the metadata or properties of a specific column in a board, such as its type or settings.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier of the board being modified or accessed. This value is used to target the specific board for the operation. |
Id |
String |
True | The unique identifier for the column being targeted within the board, necessary to reference the column for updates or changes. |
ColumnProperty |
String |
True | The specific property of the column to be modified, such as 'title' or 'description', indicating which aspect of the column is being updated. The allowed values are title, description. |
Value |
String |
False | The new value to be assigned to the column property (for example, the new title or description) as part of the update operation. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating whether the operation was successful. A value of true means the operation completed without errors, while false indicates failure. |
Details |
String |
A message containing additional details or context about the operation's execution, such as error messages or success confirmations. |
Id |
String |
The unique identifier of the column that was updated, which serves as confirmation of the operation and can be used for further reference. |
ClearItemUpdates
Removes all updates associated with a specific item on a board, clearing its update history.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ItemId |
String |
True | The unique identifier of the item being processed in the operation. This value is used to fetch or reference the specific item from the database. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating the success of the operation. A value of true confirms the operation was executed successfully, while false means there was an issue. |
Details |
String |
A string containing additional information about the operation's execution, which could include errors, warnings, or other relevant insights about the process. |
ItemId |
String |
The unique identifier of the item that was created, updated, or affected by the operation, returned as part of the result set. |
CreateColumn
Creates a new column in a board, allowing for customized data fields.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier of the board where the operation will take place. This is used to specify which board is being modified or referenced. |
Title |
String |
True | The title to be assigned to the new column, which helps define the column's purpose or function within the board. |
Description |
String |
False | A detailed description for the new column, explaining its intended use or functionality within the context of the board. |
ColumnType |
String |
True | Specifies the data type of the new column, such as text, number, or date, which determines the kind of data that can be stored in the column. |
Defaults |
String |
False | The default value to be set for the new column, which will be applied to existing records if no value is provided during insertion or update. |
Id |
String |
False | The user-defined unique identifier for the new column, used to distinguish it from other columns within the same board. |
AfterColumnId |
String |
False | The unique identifier of the column after which the new column will be inserted, determining the order in which columns appear. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating the success or failure of the operation. True means the operation was completed successfully, while false indicates an error occurred. |
Details |
String |
Provides additional information about the execution of the operation, including any warnings or errors that occurred during the process. |
Id |
String |
The unique identifier of the column that was created or modified as part of the operation, confirming its existence in the board schema. |
CreateDocBlock
Adds a new content block to a document associated with a workspace.
Input
| Name | Type | Required | Description |
|---|---|---|---|
DocId |
String |
True | The unique identifier for the document being referenced or modified. It is used to associate the operation with a specific document in the database. |
AfterBlockId |
String |
False | The identifier for the block that the new block should follow in the document. If this is not provided, the new block will be inserted at the beginning of the document. |
ParentBlockId |
String |
False | The identifier for the parent block under which the new block should be appended. This helps structure the document's hierarchical content. |
Type |
String |
True | The content type of the block being inserted, which defines the nature or format of the data (for example, text, image, table). The allowed values are board, bulleted_list, check_list, code, divider, image, large_title, layout, medium_title, normal_text, notice_box, numbered_list, quote, small_title, table, video, widget. |
Content |
String |
True | The actual content of the block being inserted into the document. This could be text, data, or other relevant content specific to the block type. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating the result of the operation. A value of true signifies that the operation was completed successfully, while false indicates that an error occurred. |
Details |
String |
Provides additional information or context about the operation's outcome, such as warnings, partial successes, or specific issues encountered during execution. |
DocumentBlockId |
String |
The unique identifier assigned to the new block created within the document. This ID is used for future references and modifications to the block. |
CreateDocBoard
Creates a new document within a workspace board.
Input
| Name | Type | Required | Description |
|---|---|---|---|
ItemId |
String |
True | The unique identifier for the item being processed in the stored procedure. This ID is used to reference a specific item in the system's database or table. |
ColumnId |
String |
True | The unique identifier for the column being targeted by the stored procedure. This ID helps to identify and reference the specific column within the table or data structure. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating whether the stored procedure was executed successfully. A value of 'true' means the procedure completed without errors, while 'false' signifies that an error occurred during execution. |
Details |
String |
A text field that provides additional information regarding the operation's outcome. It can include error messages, warnings, or success messages to give more context about the procedure's execution. |
DocumentId |
String |
The unique identifier of the document that was either created, modified, or referenced as part of the stored procedure execution. This ID links to the document's record in the database or document management system. |
CreateNotification
Generates a new notification for users about specific events or updates.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Text |
String |
True | The content or message of the notification, describing the specific information that needs to be communicated to the user or system. |
UserId |
String |
True | The unique identifier for the user to whom the notification is being sent or associated with, typically referencing a user record in the system. |
TargetId |
String |
True | The unique identifier of the target object that the notification is directed towards, such as a specific project or post within the platform. |
TargetType |
String |
True | The type of the target object, which can either be a 'Project' or a 'Post', determining the context and scope of the notification. The allowed values are Project, Post. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating the success of the operation. A value of true signifies that the notification was successfully sent or created, while false indicates failure. |
Details |
String |
A detailed message or log providing further context or reasons for success or failure of the operation, aiding in troubleshooting or reporting. |
NotificationId |
String |
The unique identifier for the notification that was created, used to track and reference the notification in the system. |
DeleteColumn
Deletes an existing column from a board, removing its associated data.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier for the board being referenced in the procedure, used to target a specific board within the system. |
Id |
String |
True | The unique identifier for the column being targeted in the procedure, allowing operations to be performed on a specific column in the schema. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating whether the operation was successfully completed. A value of true means the operation was successful, while false indicates failure. |
Details |
String |
A string providing additional information about the execution of the operation, such as any warnings, errors, or success messages. |
Id |
String |
The unique identifier assigned to the column after the operation, ensuring proper tracking and reference within the system. |
DownloadAsset
Downloads a file that was uploaded to Monday.com by specifying the asset ID.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AssetId |
String |
True | The unique identifier of the asset to be downloaded, used to locate the asset in the system and trigger the download process. |
LocalPath |
String |
False | The full file path, including the directory and filename, where the downloaded asset will be saved on the local system. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating the result of the download operation: true signifies that the operation completed successfully, while false indicates failure. |
Details |
String |
Additional context or error messages regarding the outcome of the download process, often helpful for troubleshooting. |
FileData |
String |
If neither LocalPath nor FileStream are provided, the file's binary data is returned as a base64-encoded string for use in other processes. |
DuplicateBoard
Creates an exact copy of an existing board, including all items, columns, and structures.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier of the board being duplicated or manipulated, used to reference the specific board in the system. |
DuplicateType |
String |
True | Specifies the type of duplication for the board, such as full duplication, structural duplication, or partial duplication, to control the scope of the operation. The allowed values are duplicate_board_with_structure, duplicate_board_with_pulses, duplicate_board_with_pulses_and_updates. |
BoardName |
String |
False | An optional parameter for specifying the name of the new board. If not provided, a default name is generated based on the original board or system naming conventions. |
WorkspaceId |
String |
False | An optional destination workspace ID where the new board will be placed. If not specified, the new board will be created in the same workspace as the original. |
FolderId |
String |
False | An optional parameter to specify the destination folder within the workspace for the new board. If not provided, the new board is placed in the same folder as the original. |
KeepSubscribers |
Boolean |
False | A flag indicating whether subscribers to the original board should be copied to the new board. Defaults to false, meaning subscribers are not copied unless explicitly set to true. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag that indicates the result of the operation. A value of true indicates the duplication was successful, while false indicates an error or failure. |
Details |
String |
A message that provides additional information regarding the operation's outcome, such as error messages or warnings that can help understand partial or complete failures. |
BoardId |
String |
The unique identifier for the new board that has been created or duplicated, ensuring that the client or system can reference the new board for subsequent operations. |
DuplicateGroup
Duplicates an existing group of items within a board.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier for the board to which the group is being added, allowing the operation to associate the new group with a specific board in the system. |
GroupId |
String |
True | The unique identifier for the group being modified or created, used to target the specific group in the operation and manage its attributes. |
AddToTop |
Boolean |
False | A boolean flag that indicates whether the new group should be positioned at the top of the board, affecting the group's order relative to other groups. |
GroupTitle |
String |
False | The title or name of the group being created or updated, which will be displayed on the board to users. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value that signifies whether the operation was successful. A true value indicates the operation was executed without errors, while false indicates a failure occurred. |
Details |
String |
A text field providing additional details about the execution of the operation, such as error messages or confirmation of successful changes. |
GroupId |
String |
The unique identifier for the newly created or updated group, allowing the operation to confirm and return the group's reference for further use. |
DuplicateItem
Duplicates an item within a board, including its related data and structure.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier for the board, used to target a specific board for the operation, whether for updates or retrieval. |
WithUpdates |
Boolean |
False | Indicates whether the operation should include updates made to the item since its last version. This flag ensures that any changes to the item are considered during the procedure. |
ItemId |
String |
True | The unique identifier for the item in Monday.com, used to reference and manipulate a specific item within a board during the operation. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating the outcome of the operation. A value of true signifies that the operation completed successfully, while false means there was an error or failure. |
Details |
String |
Provides additional information about the execution of the operation, such as any warnings, partial successes, or error details to help diagnose issues. |
ItemId |
String |
The unique identifier of the item that was created, updated, or referenced during the operation, allowing for further processing or verification. |
GetOAuthAccessToken
Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Monday.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AuthMode |
String |
False | The type of authentication mode to use. The allowed values are APP, WEB. The allowed values are APP, WEB. |
Verifier |
String |
False | The verifier token returned by Monday after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
Scope |
String |
False | The scope or permissions you are requesting. |
CallbackUrl |
String |
False | The URL the user will be redirected to after authorizing your application. |
State |
String |
False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
OAuthAccessToken |
String |
The authentication token returned from Monday. |
OAuthRefreshToken |
String |
A token that may be used to obtain a new access token. |
ExpiresIn |
String |
The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL
Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.
Input
| Name | Type | Required | Description |
|---|---|---|---|
CallbackUrl |
String |
False | The URL that Monday will return to after the user has authorized your app. |
Scope |
String |
False | The scope or permissions you are requesting. |
State |
String |
False | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Monday authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
URL |
String |
The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
LikeUpdate
Registers a 'like' on a specific update, providing a quick way to acknowledge or endorse updates.
Input
| Name | Type | Required | Description |
|---|---|---|---|
UpdateId |
String |
True | The unique identifier for the update operation being processed, used to track and reference the specific update action within the system. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value indicating whether the update operation was executed successfully. A value of true means the update completed without issues, while false indicates failure. |
Details |
String |
A message or set of details providing further context about the outcome of the update operation, including any errors or special conditions encountered. |
UpdateId |
String |
The unique identifier for the update operation that was executed, returned to confirm which specific update was performed during the transaction. |
MoveItemToBoard
Moves a specific item from one board to another, preserving its associated data.
Input
| Name | Type | Required | Description |
|---|---|---|---|
BoardId |
String |
True | The unique identifier of the target board, which the operation will affect, such as moving or updating items. |
GroupId |
String |
True | The unique identifier of the group within the target board, specifying which group the item or items should be moved to. |
ItemId |
String |
True | The unique identifier of the item being moved, updated, or otherwise manipulated in the target group or board. |
ColumnsMapping |
String |
False | A mapping that defines how columns in the original board correspond to columns in the target board, ensuring data is transferred correctly. |
SubitemsColumnsMapping |
String |
False | A mapping of subitem columns between the original and target boards, ensuring subitem data is accurately aligned during the operation. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean flag indicating whether the operation was successful. True means the operation was executed successfully without errors, while false means there was a failure. |
Details |
String |
A text field providing additional details about the operation, such as error messages or descriptions of partial successes if the operation did not fully succeed. |
ItemId |
String |
The unique identifier of the item that was processed, returned for reference or further use in subsequent operations. |
PinUpdate
Pins an update to the top of the feed for better visibility and priority.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Id |
String |
True | The unique identifier for the update being performed, used to track the specific update operation in the system. |
ItemId |
String |
False | The unique identifier for the item being updated, ensuring that the correct item is targeted for the operation. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A flag indicating whether the update operation was successful. A value of true means the update was completed without errors, while false indicates failure. |
Details |
String |
A message providing additional information about the execution of the update, such as any issues encountered or warnings. |
Id |
String |
The unique identifier for the item after the update operation, used to confirm the item that was modified or returned. |
PinnedToTopItemIds |
String |
A comma-separated list of item IDs that have been pinned to the top, reflecting which items are prioritized in the current update context. |
RemoveMockAppSubscription
Removes a mock application subscription associated with the current account.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AppId |
String |
True | The unique identifier of the app for which the mocked subscription will be removed. This ID helps to target the specific app in the system. |
PartialSigningSecret |
String |
True | The last 10 characters of the app’s signing secret, used to authenticate the request and ensure the operation is performed securely. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A boolean value that indicates whether the operation completed successfully. True means the operation was successful, while false indicates failure. |
Details |
String |
A detailed message providing additional context or error information related to the operation's execution, useful for debugging or understanding issues. |
PlanId |
String |
The unique identifier for the mocked plan that was applied during the operation, allowing the system to track the specific plan in use. |
SetMockAppSubscription
Sets a mock application subscription for the current account, simulating app usage.
Input
| Name | Type | Required | Description |
|---|---|---|---|
AppId |
String |
True | The unique identifier for the application that is being used to simulate a subscription. This helps to associate the operation with the correct app in the system. |
PartialSigningSecret |
String |
True | A masked version of the app's signing secret, providing the last 10 characters. This is used to authenticate the app during the mock subscription process. |
PlanId |
String |
False | The identifier for the specific subscription plan that is being mocked, enabling the system to associate the subscription with the correct pricing structure. |
IsTrial |
Boolean |
False | A boolean flag that indicates whether the mocked subscription is a trial version. It helps to apply the appropriate subscription rules and benefits. |
RenewalDate |
Datetime |
False | The date when the subscription is set to renew. This is used to manage subscription lifecycles and calculate any recurring billing events. |
BillingPeriod |
String |
False | The frequency of the billing cycle, either monthly or yearly. This affects the subscription's renewal schedule and the pricing structure. |
PricingVersion |
Int |
False | The version of the pricing plan that is being applied. This helps ensure the mock subscription uses the correct pricing model according to the version specified. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A status flag indicating the outcome of the operation. A value of true means the subscription mock was successfully created or updated, while false indicates an error. |
Details |
String |
A message containing additional information about the operation's execution, providing insights into any issues or further details on success or failure. |
PlanId |
String |
The identifier for the mocked subscription plan returned after the operation. It confirms the plan that was successfully applied or mocked in the process. |
UnpinUpdate
Unpins a previously pinned update, returning it to the standard feed order.
Input
| Name | Type | Required | Description |
|---|---|---|---|
Id |
String |
True | The unique identifier for the update being processed, used to locate the specific update record in the database. |
ItemId |
String |
False | The unique identifier for the item involved in the update, linking the operation to a specific item in the system. |
Result Set Columns
| Name | Type | Description |
|---|---|---|
Success |
Boolean |
A flag that indicates whether the update operation was executed successfully. A value of true signifies success, while false indicates failure. |
Details |
String |
A message that provides additional context or error information related to the execution of the operation, aiding in troubleshooting or verification. |
Id |
String |
The unique identifier of the item being updated, returned to confirm which item the update was applied to. |
PinnedToTopItemIds |
String |
A comma-separated list of item IDs that have been pinned to the top as a result of the update operation, indicating prioritization in the UI or system. |
System Tables
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables
The following tables return database metadata for Monday:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database name. |
sys_schemas
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database name. |
SchemaName |
String |
The schema name. |
sys_tables
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database containing the table or view. |
SchemaName |
String |
The schema containing the table or view. |
TableName |
String |
The name of the table or view. |
TableType |
String |
The table type (table or view). |
Description |
String |
A description of the table or view. |
IsUpdateable |
Boolean |
Whether the table can be updated. |
sys_tablecolumns
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Invoices table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Invoices'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the table or view. |
SchemaName |
String |
The schema containing the table or view. |
TableName |
String |
The name of the table or view containing the column. |
ColumnName |
String |
The column name. |
DataTypeName |
String |
The data type name. |
DataType |
Int32 |
An integer indicating the data type. This value is determined at run time based on the environment. |
Length |
Int32 |
The storage size of the column. |
DisplaySize |
Int32 |
The designated column's normal maximum width in characters. |
NumericPrecision |
Int32 |
The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale |
Int32 |
The column scale or number of digits to the right of the decimal point. |
IsNullable |
Boolean |
Whether the column can contain null. |
Description |
String |
A brief description of the column. |
Ordinal |
Int32 |
The sequence number of the column. |
IsAutoIncrement |
String |
Whether the column value is assigned in fixed increments. |
IsGeneratedColumn |
String |
Whether the column is generated. |
IsHidden |
Boolean |
Whether the column is hidden. |
IsArray |
Boolean |
Whether the column is an array. |
IsReadOnly |
Boolean |
Whether the column is read-only. |
IsKey |
Boolean |
Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
ColumnType |
String |
The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
sys_procedures
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The database containing the stored procedure. |
SchemaName |
String |
The schema containing the stored procedure. |
ProcedureName |
String |
The name of the stored procedure. |
Description |
String |
A description of the stored procedure. |
ProcedureType |
String |
The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SampleProcedure stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the stored procedure. |
SchemaName |
String |
The name of the schema containing the stored procedure. |
ProcedureName |
String |
The name of the stored procedure containing the parameter. |
ColumnName |
String |
The name of the stored procedure parameter. |
Direction |
Int32 |
An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataType |
Int32 |
An integer indicating the data type. This value is determined at run time based on the environment. |
DataTypeName |
String |
The name of the data type. |
NumericPrecision |
Int32 |
The maximum precision for numeric data. The column length in characters for character and date-time data. |
Length |
Int32 |
The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericScale |
Int32 |
The number of digits to the right of the decimal point in numeric data. |
IsNullable |
Boolean |
Whether the parameter can contain null. |
IsRequired |
Boolean |
Whether the parameter is required for execution of the procedure. |
IsArray |
Boolean |
Whether the parameter is an array. |
Description |
String |
The description of the parameter. |
Ordinal |
Int32 |
The index of the parameter. |
Values |
String |
The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
SupportsStreams |
Boolean |
Whether the parameter represents a file that you can pass as either a file path or a stream. |
IsPath |
Boolean |
Whether the parameter is a target path for a schema creation operation. |
Default |
String |
The value used for this parameter when no value is specified. |
SpecificName |
String |
A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
IsProvided |
Boolean |
Whether the procedure is added/implemented by , as opposed to being a native Monday procedure. |
Pseudo-Columns
| Name | Type | Description |
|---|---|---|
IncludeResultColumns |
Boolean |
Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
sys_keycolumns
Describes the primary and foreign keys.
The following query retrieves the primary key for the Invoices table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Invoices'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the key. |
SchemaName |
String |
The name of the schema containing the key. |
TableName |
String |
The name of the table containing the key. |
ColumnName |
String |
The name of the key column. |
IsKey |
Boolean |
Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey |
Boolean |
Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName |
String |
The name of the primary key. |
ForeignKeyName |
String |
The name of the foreign key. |
ReferencedCatalogName |
String |
The database containing the primary key. |
ReferencedSchemaName |
String |
The schema containing the primary key. |
ReferencedTableName |
String |
The table containing the primary key. |
ReferencedColumnName |
String |
The column name of the primary key. |
sys_foreignkeys
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the key. |
SchemaName |
String |
The name of the schema containing the key. |
TableName |
String |
The name of the table containing the key. |
ColumnName |
String |
The name of the key column. |
PrimaryKeyName |
String |
The name of the primary key. |
ForeignKeyName |
String |
The name of the foreign key. |
ReferencedCatalogName |
String |
The database containing the primary key. |
ReferencedSchemaName |
String |
The schema containing the primary key. |
ReferencedTableName |
String |
The table containing the primary key. |
ReferencedColumnName |
String |
The column name of the primary key. |
ForeignKeyType |
String |
Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the key. |
SchemaName |
String |
The name of the schema containing the key. |
TableName |
String |
The name of the table containing the key. |
ColumnName |
String |
The name of the key column. |
KeySeq |
String |
The sequence number of the primary key. |
KeyName |
String |
The name of the primary key. |
sys_indexes
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
| Name | Type | Description |
|---|---|---|
CatalogName |
String |
The name of the database containing the index. |
SchemaName |
String |
The name of the schema containing the index. |
TableName |
String |
The name of the table containing the index. |
IndexName |
String |
The index name. |
ColumnName |
String |
The name of the column associated with the index. |
IsUnique |
Boolean |
True if the index is unique. False otherwise. |
IsPrimary |
Boolean |
True if the index is a primary key. False otherwise. |
Type |
Int16 |
An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder |
String |
The sort order: A for ascending or D for descending. |
OrdinalPosition |
Int16 |
The sequence number of the column in the index. |
sys_connection_props
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
| Name | Type | Description |
|---|---|---|
Name |
String |
The name of the connection property. |
ShortDescription |
String |
A brief description. |
Type |
String |
The data type of the connection property. |
Default |
String |
The default value if one is not explicitly set. |
Values |
String |
A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value |
String |
The value you set or a preconfigured default. |
Required |
Boolean |
Whether the property is required to connect. |
Category |
String |
The category of the connection property. |
IsSessionProperty |
String |
Whether the property is a session property, used to save information about the current connection. |
Sensitivity |
String |
The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName |
String |
A camel-cased truncated form of the connection property name. |
Ordinal |
Int32 |
The index of the parameter. |
CatOrdinal |
Int32 |
The index of the parameter category. |
Hierarchy |
String |
Shows dependent properties associated that need to be set alongside this one. |
Visible |
Boolean |
Informs whether the property is visible in the connection UI. |
ETC |
String |
Various miscellaneous information about the property. |
sys_sqlinfo
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
|---|---|---|
AGGREGATE_FUNCTIONS |
Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT |
Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR |
The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR |
The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS |
A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY |
Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
STRING_FUNCTIONS |
Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS |
Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS |
Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES |
Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS |
A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN |
String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION |
Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT |
Indicates the SQL dialect to use. | |
KEY_PROPERTIES |
Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS |
Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS |
Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION |
The Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY |
The Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL |
Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS |
Whether batch operations are supported. | YES, NO |
SQL_CAP |
All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS |
A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY |
Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS |
A string array indicating the available pseudo columns. | |
MERGE_ALWAYS |
If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY |
A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION |
Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE |
Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY |
A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION |
Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE |
A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID |
Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES |
Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns
| Name | Type | Description |
|---|---|---|
NAME |
String |
A component of SQL syntax, or a capability that can be processed on the server. |
VALUE |
String |
Detail on the supported SQL or SQL syntax. |
sys_identity
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns
| Name | Type | Description |
|---|---|---|
Id |
String |
The database-generated ID returned from a data modification operation. |
Batch |
String |
An identifier for the batch. 1 for a single operation. |
Operation |
String |
The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message |
String |
SUCCESS or an error message if the update in the batch failed. |
sys_information
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
Columns
| Name | Type | Description |
|---|---|---|
Product |
String |
The name of the product. |
Version |
String |
The version number of the product. |
Datasource |
String |
The name of the datasource the product connects to. |
NodeId |
String |
The unique identifier of the machine where the product is installed. |
HelpURL |
String |
The URL to the product's help documentation. |
License |
String |
The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
Location |
String |
The file path location where the product's library is stored. |
Environment |
String |
The version of the environment or rumtine the product is currently running under. |
DataSyncVersion |
String |
The tier of Sync required to use this connector. |
DataSyncCategory |
String |
The category of Sync functionality (e.g., Source, Destination). |
Advanced Configurations Properties
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
| Property | Description |
|---|---|
Schema |
Limits displayed tables to those in the specified schema. |
AuthScheme |
The type of authentication to use when connecting to Monday. |
APIToken |
An API token associated with your Monday account. |
URL |
Your Monday account URL. |
Domain |
This property is deprecated. Use the URL connection property instead. |
| Property | Description |
|---|---|
InitiateOAuth |
Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
OAuthClientId |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
OAuthClientSecret |
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. |
OAuthAccessToken |
Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
OAuthSettingsLocation |
Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes. |
CallbackURL |
Identifies the URL users return to after authenticating to Monday via OAuth. (Custom OAuth applications only.). |
Scope |
Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials. |
OAuthVerifier |
Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
OAuthRefreshToken |
Specifies the OAuth refresh token used to request a new access token after the original has expired. |
OAuthExpiresIn |
Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
OAuthTokenTimestamp |
Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created. |
| Property | Description |
|---|---|
SSLServerCert |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
|---|---|
Location |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
BrowsableSchemas |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables |
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC. |
Views |
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
| Property | Description |
|---|---|
MaxPointsPerCall |
Specifies the maximum points allowed by the provider for a single API call. |
MaxRows |
Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
Other |
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
PseudoColumns |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
ServerFirstDayOfWeek |
The first day of the week, as defined in your account settings. |
ServerTimezone |
The time zone of your Monday account. |
Timeout |
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
UseDisplayColumnNames |
Boolean determining if the column names should match display names or internal API names (IDs). |
UseDisplaySchemaNames |
Boolean determining if the schema names should match display names or internal API names (IDs). |
UseDisplayTableNames |
Boolean determining if the table names should match display names or internal API names (IDs). |
UserDefinedViews |
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Authentication
This section provides a complete list of authentication properties you can configure.
| Property | Description |
|---|---|
Schema |
Limits displayed tables to those in the specified schema. |
AuthScheme |
The type of authentication to use when connecting to Monday. |
APIToken |
An API token associated with your Monday account. |
URL |
Your Monday account URL. |
Domain |
This property is deprecated. Use the URL connection property instead. |
Schema
Limits displayed tables to those in the specified schema.
Data Type
string
Default Value
""
Remarks
By default, the connector lists tables from the following schemas:
- "Information" - Account-level details about your Monday instance.
- "AuditLog" - Audit log events associated with your Monday account.
- "Main workspace" - For older accounts that have not been migrated to the API's new method of querying the main workspace, the connector exposes this dedicated name for the schema associated with your Main Workspace. In this case, this name is used regardless of the Main Workspace's actual name.
- One distinct schema for each other workspace. The name of these schemas are taken directly from the workspace name, formatted exactly like the workspace name seen in the Monday UI.
Set this connection property to one of the schemas listed above to only show the tables and views associated with the schema specified.
For example, if you set this property to "Main workspace", the connector only lists tables and views from the Main Workspace.
AuthScheme
The type of authentication to use when connecting to Monday.
Possible Values
Token, OAuth
Data Type
string
Default Value
Token
Remarks
You can set this connection property to one of the following:
- Token: Set this to authenticate to the Monday GraphQL API with a personal access token or the AuditLog API with an audit log API token. When this is selected, you must supply an API token in the APIToken connection property.
- OAuth: Set this to authenticate to Monday using OAuth 2.0 authentication. When this is selected, you must supply the OAuthClientId and OAuthClientSecret connection properties. See Creating a Custom OAuth Application for information about how to obtain these values.
APIToken
An API token associated with your Monday account.
Data Type
string
Default Value
""
Remarks
This connection property is required when AuthScheme is set to Token.
The value you should set in this property varies depending on the API you want to access.
Monday GraphQL API
To retrieve data from the GraphQL API, set this connection property to the value of a personal API token associated with your Monday account.
Finding your API Token (Administration Menu)
If you are an admin user on your monday.com account, you are able to access your API tokens from the "Administration" tab with the following steps:
- Log into your monday.com account.
- Click on your avatar (picture icon) in the top right corner of your screen.
- Select
Administrationfrom the resulting menu (this requires you to have admin permissions). - In the left-hand navigation, click
Connections, then click theAPItab in the resulting page. - Under
Personal API Token, clickCreate tokento create an personal API token. Set this connection property to this value.- If you've already made a token, under
Personal API Token, click theCopybutton to copy your API token.
- If you've already made a token, under
Finding your API Token (Developer Menu)
If you are a member user on your monday.com account, you are able to access your API tokens from the Developer tab with the following steps:
- Log into your monday.com account.
- Click on your avatar (picture icon) in the top right corner of your screen.
- Select
Developersfrom the resulting menu. - In the left-hand navigation, click
My access tokens. - Click
Show > Copyto copy your API token. Set this connection property to this value.
Monday AuditLog API
If you want to access data from the AuditLog API, set this connection property to the value of a AuditLog API token.
Note
You must have an enterprise subscription with Monday to access the AuditLog API.
Finding your AuditLog API Token
- Log into your monday.com account.
- Click on your avatar (picture icon) in the top right corner of your screen.
- Select
Administrationfrom the resulting menu. - In the left-hand navigation, click
Security. - Click the
Audittab. - Click
Monitor by API > Copyto copy your AuditLog API token. Set this connection property to this value.
URL
Your Monday account URL.
Data Type
string
Default Value
""
Remarks
This connection property is only required when the Schema is set to "AuditLog".
You can copy the URL of your Monday homepage after logging in.
The format of the URL is https://{accountName}.monday.com/
For example: https://cdata-software.monday.com/.
Domain
*Note:* Replaced by 'URL'.
This property is deprecated. Use the URL connection property instead.
Data Type
string
Default Value
""
Remarks
Specifies the domain of your Monday account, required only for tables in the AuditLog schema.
Example: https://yourdomain.monday.com
OAuth
This section provides a complete list of OAuth properties you can configure.
| Property | Description |
|---|---|
InitiateOAuth |
Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
OAuthClientId |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
OAuthClientSecret |
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. |
OAuthAccessToken |
Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
OAuthSettingsLocation |
Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes. |
CallbackURL |
Identifies the URL users return to after authenticating to Monday via OAuth. (Custom OAuth applications only.). |
Scope |
Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials. |
OAuthVerifier |
Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
OAuthRefreshToken |
Specifies the OAuth refresh token used to request a new access token after the original has expired. |
OAuthExpiresIn |
Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
OAuthTokenTimestamp |
Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created. |
InitiateOAuth
Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
Possible Values
OFF, REFRESH, GETANDREFRESH
Data Type
string
Default Value
OFF
Remarks
OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for logging in users, exchanging their credentials for an OAuth access token to be used for authentication, and providing limited access to applications.
Monday supports the following options for initiating OAuth access:
OFF: No automatic OAuth flow initiation. The OAuth flow is handled entirely by the user, who will take action to obtain their OAuthAccessToken. Note that with this setting the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.GETANDREFRESH: The OAuth flow is handled entirely by the connector. If a token already exists, it is refreshed when necessary. If no token currently exists, it will be obtained by prompting the user to login.REFRESH: The user handles obtaining the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate. After the user logs in, the connector handles the refresh of the OAuth Access Token.
OAuthClientId
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
Data Type
string
Default Value
""
Remarks
This property is required when using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration. It is also required if an embedded OAuth application is not available for the driver. When an embedded OAuth application is available, this value may already be provided by the connector and not require manual entry.
This value is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can typically find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
OAuthClientSecret
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.
Data Type
string
Default Value
""
Remarks
This property is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication will fail, and the server may return an invalid_client or unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application. It may be referred to as the client secret, application secret, or consumer secret.
This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments. Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.
OAuthAccessToken
Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
Data Type
string
Default Value
""
Remarks
The OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.
The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.
If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.
Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.
OAuthSettingsLocation
Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.
Data Type
string
Default Value
%APPDATA%\Monday Data Provider\OAuthSettings.txt
Remarks
You can store OAuth values in a central file for shared access to those values, in either of the following ways:
- Set InitiateOAuth to either
GETANDREFRESHorREFRESHand specify a filepath to the OAuth settings file. - Use memory storage to load the credentials into static memory.
The following sections provide more detail on each of these methods.
Specifying the OAuthSettingsLocation Filepath
The default OAuth setting location is %APPDATA%\Monday Data Provider\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory.
Default values vary, depending on the user's operating system.
Windows(ODBC and Power BI):registry://%DSN%Windows:%APPDATA%Monday Data Provider\OAuthSettings.txtMac:%APPDATA%//Monday Data Provider/OAuthSettings.txtLinux:%APPDATA%//Monday Data Provider/OAuthSettings.txt
Loading Credentials Via Memory Storage
Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.
Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.
To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
Supported Storage Types
memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name likeregistry://Jitterbit Connector for Monday Data Source, orregistry://%DSN%.%DSN%: The name of the DSN you are connecting with.Default(no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with%APPDATA%or%PROGRAMFILES%.
CallbackURL
Identifies the URL users return to after authenticating to Monday via OAuth. (Custom OAuth applications only.).
Data Type
string
Default Value
""
Remarks
If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you Configured the custom OAuth application.
Scope
Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.
Data Type
string
Default Value
me:read boards:read boards:write workspaces:read workspaces:write docs:read docs:write webhooks:read webhooks:write users:read account:read updates:read updates:write assets:read tags:read teams:read notifications:write
Remarks
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested. When InitiateOAuth is set to either REFRESH or OFF, you can use either this property or the Scope input to change which scopes are requested.
OAuthVerifier
Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
Data Type
string
Default Value
""
OAuthRefreshToken
Specifies the OAuth refresh token used to request a new access token after the original has expired.
Data Type
string
Default Value
""
Remarks
The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.
The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessToken stored procedure if you prefer to manage the refresh manually.
When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.
The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.
OAuthExpiresIn
Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
Data Type
string
Default Value
""
Remarks
The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.
An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.
To determine how long the user has before the Access Token will expire, use OAuthTokenTimestamp.
OAuthTokenTimestamp
Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.
Data Type
string
Default Value
""
Remarks
The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.
An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.
SSL
This section provides a complete list of SSL properties you can configure.
| Property | Description |
|---|---|
SSLServerCert |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
|---|---|
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema
This section provides a complete list of schema properties you can configure.
| Property | Description |
|---|---|
Location |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
BrowsableSchemas |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables |
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC. |
Views |
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
Data Type
string
Default Value
%APPDATA%\Monday Data Provider\Schema
Remarks
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\Monday Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
|---|---|
Windows |
The value of the APPDATA environment variable |
Mac |
~/Library/Application Support |
Linux |
~/.config |
BrowsableSchemas
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type
string
Default Value
""
Remarks
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Tables
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.
Data Type
string
Default Value
""
Remarks
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note
If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Views
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type
string
Default Value
""
Remarks
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note
If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
Miscellaneous
This section provides a complete list of miscellaneous properties you can configure.
| Property | Description |
|---|---|
MaxPointsPerCall |
Specifies the maximum points allowed by the provider for a single API call. |
MaxRows |
Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
Other |
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
PseudoColumns |
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
ServerFirstDayOfWeek |
The first day of the week, as defined in your account settings. |
ServerTimezone |
The time zone of your Monday account. |
Timeout |
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
UseDisplayColumnNames |
Boolean determining if the column names should match display names or internal API names (IDs). |
UseDisplaySchemaNames |
Boolean determining if the schema names should match display names or internal API names (IDs). |
UseDisplayTableNames |
Boolean determining if the table names should match display names or internal API names (IDs). |
UserDefinedViews |
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
MaxPointsPerCall
Specifies the maximum points allowed by the provider for a single API call.
Data Type
string
Default Value
100000
Remarks
The connector translates your SQL queries to Monday API calls. The Monday API assigns a certain number complexity points to all API calls made to it and places limits on how many complexity points worth of calls you can request under various circumstances.
The connector ensures that all queries you execute consume at or below the number of complexity points set in this connection property, where possible. If the minimum viable API call needed to fulfill your query exceeds this limit, the connector still submits that call, since it cannot be optimized further.
Note that you cannot set a limit that exceeds the hard limits imposed by the Monday API. The total cost of a single query cannot exceed 5,000,000 points. Standard accounts using personal API tokens cannot exceed 10,000,000 points per minute, while trial and free accounts using personal API tokens are limited to 1,000,000 points per minute. Accounts using OAuth are limited to 5,000,000 points per minute.
You can reduce the complexity of API calls by selecting only the necessary columns in your SQL queries, as this affects the depth and structure of the generated GraphQL query.
MaxRows
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Data Type
int
Default Value
-1
Remarks
This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Other
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Data Type
string
Default Value
""
Remarks
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note
It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting
| Property | Description |
|---|---|
DefaultColumnSize |
Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT=True |
Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
RecordToFile=filename |
Records the underlying socket data transfer to the specified file. |
PseudoColumns
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Data Type
string
Default Value
""
Remarks
This property allows you to define which pseudocolumns the connector exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
ServerFirstDayOfWeek
The first day of the week, as defined in your account settings.
Possible Values
Auto, Monday, Sunday
Data Type
string
Default Value
Auto
Remarks
The allowed values are:
- Auto: A request is executed to retrieve the configuration from the API. Requires the scope 'me:read'.
- Monday: Use this if your Monday account is configured to use Monday as the first day of the week.
- Sunday: Use this if your Monday account is configured to use Sunday as the first day of the week.
See this page for more information.
ServerTimezone
The time zone of your Monday account.
Data Type
string
Default Value
""
Remarks
This property specifies the time zone used to filter board items by UpdatedAt. By default, the connector automatically resolves the time zone.
Possible values include "GMT", "America/New_York", etc.
Timeout
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
Data Type
int
Default Value
60
Remarks
This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
UseDisplayColumnNames
Boolean determining if the column names should match display names or internal API names (IDs).
Data Type
bool
Default Value
true
Remarks
Affects only dynamic columns i.e.: columns mapped to Monday board fields.
UseDisplaySchemaNames
Boolean determining if the schema names should match display names or internal API names (IDs).
Data Type
bool
Default Value
true
Remarks
Affects only dynamic schemas i.e.: schemas mapped to Monday workspaces.
UseDisplayTableNames
Boolean determining if the table names should match display names or internal API names (IDs).
Data Type
bool
Default Value
true
Remarks
Affects only dynamic tables i.e.: tables mapped to Monday boards.
UserDefinedViews
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Data Type
string
Default Value
""
Remarks
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM Invoices WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.
Refer to User Defined Views for more information.