Workspaces

Retrieves a collection of workspaces, including their names and details.

Table-Specific Information

SELECT

The add-in uses the Monday API to process some of the filters. The add-in processes other filters client-side within the add-in.

Id supports the '=','IN' comparison operators.
Kind supports the '=' comparison operator.
State supports the '=' comparison operator.

For example, the following queries are processed server-side:

  SELECT * FROM Workspaces WHERE Id = '3578971'
  SELECT * FROM Workspaces WHERE Id IN ('3578971','3578972')
  SELECT * FROM Workspaces WHERE Kind = 'open'
  SELECT * FROM Workspaces WHERE State = 'active'

INSERT

The following columns can be used to create a new record:

Description, Kind, Name, AccountProductId

INSERT INTO Workspaces (Name,Kind,Description,AccountProductId) VALUES ('New Workspace','open','This is my new workspace.','1244553456')

UPDATE

The following columns can be updated:

Description, Kind, Name, AccountProductId

UPDATE Workspaces SET Description = 'testDescription', Name = 'testName', Kind = 'open', AccountProductId='1244553456' WHERE Id = '3819431'

DELETE

You can delete entries by specifying the following column:

DELETE FROM Workspaces WHERE Id = '3819431'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		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	True		Describes the current state of the workspace, which can be 'all', 'active', 'archived', or 'deleted', indicating its lifecycle status.
CreatedAt	Datetime	True		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	True		Specifies the type of product tied to the account, such as core, marketing, CRM, software, project management, forms, or whiteboard.
SettingsIconColor	String	True		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	True		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	True		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	True		The URL associated with the workspace, providing direct access or linking to resources or data within the workspace.