The CData Sync App provides a straightforward way to continuously pipeline your Monday data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Monday connector can be used from the CData Sync application to pull data from Monday and move it to any of the supported destinations.
The Sync App leverages the Monday API to enable bidirectional access to Monday.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The Monday AuditLog API only supports authentication via API Token.
To generate the audit log API token:
After you retrieve the API token, set the following connection properties:
The Monday GraphQL API supports authentication via either API Token or the OAuth standard.
To connect to Sync App via an API Token, set the AuthScheme to Token and obtain the APIToken as follows:
The following subsections describe how to authenticate to Monday from three common authentication flows:
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.
When the access token expires, the Sync App refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the Sync App automatically refresh the OAuth access token, do the following:
This section details a selection of advanced features of the Monday Sync App.
The Sync App 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 .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App 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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App models Monday data as an easy-to-use SQL database with tables, views, and stored procedures.
The provider exposes three kinds of schemas:
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.
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 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.
The Sync App models the data in Monday as a list of tables in a relational database that can be queried using standard SQL statements.
| 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. |
Retrieves content blocks from documents associated with boards. Requires a DocId or DocObjectId filter to narrow results.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
Note: This table requires specifying DocId to retrieve data.
SELECT * FROM BoardDocBlocks WHERE DocId = '9014425'
SELECT * FROM BoardDocBlocks WHERE DocId IN ('9014425','9014490')
SELECT * FROM BoardDocBlocks WHERE DocId IN (SELECT ColumnDocId FROM Board)
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')
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'
You can delete entries by specifying the Id.
DELETE FROM BoardDocBlocks WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
| 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 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. |
Fetches a collection of documents associated with boards. Requires specifying an Id or ObjectId filter to identify the desired documents.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
Note: This table requires specifying either Id or ObjectId to retrieve data.
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)
The following inputs can be used in INSERT statements:
ItemId, ColumnId
INSERT INTO BoardDocs (ItemId, ColumnId) VALUES ('1647941525','monday_doc__1')
| 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 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. |
Retrieves a collection of boards, including their details and associated data.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
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'
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)
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'
You can delete entries by specifying the Id.
DELETE FROM Boards WHERE Id = '5549166043'
| 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 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. |
Fetches a list of team subscribers associated with a specific board.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM BoardTeams WHERE BoardId='5557271485'
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardTeams (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
You can delete entries by specifying the Id and BoardId.
DELETE FROM BoardTeams WHERE Id='51688059' AND BoardId='5546871560'
| 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. |
Retrieves a list of user subscribers for a specific board.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM BoardUsers WHERE BoardId = '5525287714'
SELECT * FROM BoardUsers WHERE Kind = 'owner'
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardUsers (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
You can delete entries by specifying the Id and BoardId.
DELETE FROM BoardUsers WHERE Id = '51688059' AND BoardId = '5546871560'
| 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. |
Retrieves the visible columns for a specific board, providing structural information.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM Columns WHERE Id = 'name'
SELECT * FROM Columns WHERE Id IN ('name', 'status')
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')
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'
You can delete entries by specifying the Id and BoardId.
DELETE FROM Boards WHERE Id='test' AND BoardId='3820334'
| 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 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. |
Retrieves metadata about custom activities in the Email and Activities timeline for enhanced activity tracking.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM CustomActivities WHERE Id ='a91e9318-798a-44a6-80a4-49a14e23c015'
SELECT * FROM CustomActivities WHERE Color ='MEDIUM_TURQUOISE'
The following inputs can be used in INSERT statements:
Name, IconId, Color
INSERT INTO CustomActivities (Name, IconId, Color) values ('CActivity', 'CAMERA', 'MEDIUM_TURQUOISE')
You can delete entries by specifying the Id.
DELETE FROM CustomActivities WHERE Id='a91e9318-798a-44a6-80a4-49a14e23c015'
| 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. |
Fetches content blocks within documents associated with workspaces.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM DocBlocks WHERE DocId = '9014425'
SELECT * FROM DocBlocks WHERE DocId IN ('9014425','9014490')
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')
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'
You can delete entries by specifying the Id.
DELETE FROM DocBlocks WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
| 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 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. |
Retrieves a collection of documents from workspaces, including their metadata.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
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'
The following inputs can be used in INSERT statements:
WorkspaceId, DocKind, Name
INSERT INTO Docs (WorkspaceId,DocKind,Name) VALUES ('3820334','public','CreatedDoc')
| 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. |
Retrieves a collection of folders within workspaces. Excludes folders in closed workspaces unless you are subscribed to them.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM Folders WHERE Id = '12622355'
SELECT * FROM Folders WHERE WorkspaceId = '3578971'
The following inputs can be used in INSERT statements:
ParentId, WorkspaceId, Color, Name
INSERT INTO Folders (WorkspaceId,Name,Color) VALUES ('3578971','TestFolder','BRIGHT_BLUE')
The following inputs can be used in UPDATE statements:
ParentId, Color, Name
UPDATE Folders SET Color = 'SUNSET', Name = 'UpdatedName' WHERE Id = '12678064'
You can delete entries by specifying the Id.
DELETE FROM Folders WHERE Id='12678064'
| 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. |
Retrieves the visible groups for a specified board, providing a structured view of grouped items.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
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'
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')
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'
You can delete entries by specifying the Id and BoardId.
DELETE FROM Groups WHERE BoardId = '5525287714' AND Id = 'testgroup'
| 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 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. |
Retrieves a collection of tags used to categorize and filter items across boards.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE Id = '13327214'
SELECT * FROM Tags WHERE Id IN ('13327214', '13327217')
The following inputs can be used in INSERT statements:
Name, BoardId
INSERT INTO Tags (Name) VALUES ('TestTagName')
| 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. |
Retrieves the list of users assigned to a specific team.
| 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. |
Provides metadata about items displayed in the Email and Activities timeline.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM TimelineItems WHERE Id ='2b748808-9311-4f76-80de-49baac5609e1'
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');
You can delete entries by specifying the Id.
DELETE FROM TimelineItems WHERE Id='2b748808-9311-4f76-80de-49baac5609e1'
| 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. | |
| 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 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. |
| Content | String |
The detailed content or description of the timeline item, which could include notes, tasks, or additional context about 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. |
| Timestamp | Datetime |
The creation time of the event associated with the timeline item, used to track when the item was created or modified. |
| 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. |
Fetches a collection of updates, including user comments, status changes, and other activity logs.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
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'
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')
You can delete entries by specifying the Id.
DELETE FROM Updates WHERE Id = '2553512994'
| 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. | |
| 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 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. |
Fetches a collection of webhooks, including their configuration and associated events.
The Sync App uses the Monday API to process WHERE clause conditions built with the following column and operator. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM Webhooks WHERE BoardId = '5574930939'
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/')
You can delete entries by specifying the Id.
DELETE FROM Webhooks WHERE Id = '242031214'
| 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 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. |
Retrieves a collection of workspaces, including their names and details.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
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'
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.')
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'
You can delete entries by specifying the Id.
DELETE FROM Workspaces WHERE Id = '3819431'
| 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. |
Retrieves the list of teams subscribed to a specific workspace.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM WorkspaceTeams WHERE Kind = 'owner'
SELECT * FROM WorkspaceTeams WorkspaceId = '3820334'
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')
You can delete entries by specifying the Id and WorkspaceId.
DELETE FROM WorkspaceTeams WHERE Id = '961021' AND WorkspaceId = '3820334'
| 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. |
Fetches the list of users subscribed to a specific workspace.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM WorkspaceUsers WHERE WorkspaceId = '3578971'
SELECT * FROM WorkspaceUsers WHERE Kind = 'owner'
The following inputs can be used in INSERT statements:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceUsers (Id,WorkspaceId,Kind) VALUES ('51688059','3820334','subscriber')
You can delete entries by specifying the Id and WorkspaceId.
DELETE FROM WorkspaceUsers WHERE Id = '51688059' AND WorkspaceId = '3820334'
| 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 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.
| 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. |
| Users | Retrieves a collection of users, including their details and roles. |
Fetches the activity log events associated with a specific board, detailing recent updates and actions.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
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'
| 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. |
Retrieves a collection of assets based on provided asset IDs, such as files or media associated with items.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM Assets WHERE Id = '397532775'
SELECT * FROM Assets WHERE Id IN ('397532775', '397532776')
| 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. |
Fetches a list of views configured for a specific board.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM BoardViews WHERE BoardId = '2182296646'
SELECT * FROM BoardViews WHERE Type = 'Chart'
SELECT * FROM BoardViews WHERE BoardId IN ('2182296646', '2181960030')
| 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. |
Fetches a collection of teams, including their details and associated users.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
SELECT * FROM Teams WHERE Id = '565332'
SELECT * FROM Teams WHERE Id IN ('565332, 565333')
| 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. |
Retrieves a collection of users, including their details and roles.
The Sync App uses the Monday API to process some of the filters. The Sync App processes other filters client-side within the Sync App.
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 = '[email protected]'
SELECT * FROM Users WHERE Email IN ('[email protected]', '[email protected]')
SELECT * FROM Users WHERE TeamsIds = '915408'
| 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. | |
| 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. |
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.
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 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.
| Name | Description |
| AuditLogs | Retrieves the audit log events for a specific board, providing a detailed history of actions performed. |
Retrieves the audit log events for a specific board, providing a detailed history of actions performed.
All available values for the event filter are listed and explained below:
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'
| 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. |
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.
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 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.
The Sync App models the data in Monday as a list of tables in a relational database that can be queried using standard SQL statements.
| 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. |
Represents a workspace board containing items, columns, and other related data used for task management.
Note that multiple filters are supported server-side (when they are all connected solely by AND logical operators or solely by OR logical operators).
The following columns are sorted server-side when including an ORDER BY clause:
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
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','[email protected]','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')
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 = '[email protected]',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'
You can delete items by specifying the ItemId.
DELETE FROM Board WHERE ItemId = '5561890829'
| 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. | |
| 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 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. |
Represents a subitems board, storing nested items related to a primary board's items for more detailed task tracking.
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
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')
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'
You can delete entries by specifying the ItemId.
DELETE FROM BoardSubItems WHERE ItemId = '5561890829'
| 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 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. |
The connection string 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 in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| 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 |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| 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. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| 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. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| 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. |
Limits displayed tables to those in the specified schema.
By default, the Sync App lists tables from the following schemas:
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 Sync App only lists tables and views from the Main Workspace.
The type of authentication to use when connecting to Monday.
You can set this connection property to one of the following:
An API token associated with your Monday account.
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.
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:
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:
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
Your Monday account URL.
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/.
This property is deprecated. Use the URL connection property instead.
Specifies the domain of your Monday account, required only for tables in the AuditLog schema.
Example: https://yourdomain.monday.com
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| 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. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
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.
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.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
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.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Monday. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Monday. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Monday. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| 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 . |
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.
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%\\CData\\Monday Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
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.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
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.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| 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. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum points allowed by the provider for a single API call.
The Sync App 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 Sync App 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 Sync App 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.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App 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.
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.
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.
| 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 | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
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.
This property allows you to define which pseudocolumns the Sync App 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: "*=*"
The first day of the week, as defined in your account settings.
The allowed values are:
See this page for more information.
The time zone of your Monday account.
This property specifies the time zone used to filter board items by UpdatedAt. By default, the Sync App automatically resolves the time zone.
Possible values include "GMT", "America/New_York", etc.
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.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App 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 60 seconds 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.
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
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 Sync App 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 Sync App.
Refer to User Defined Views for more information.