Salesforce Docs Portal

Monday Connector Objects (information Schema)

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

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.
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.
BoardViews Fetches a list of views configured 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.
Teams Fetches a collection of teams, including their details and associated users.
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.
Users Retrieves a collection of users, including their details and roles.
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.

ActivityLogs

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier of the activity log event, used to track and retrieve specific log entries.
BoardId String False Boards.id No The unique identifier of the board associated with the activity, providing context for the event.
AccountId String False No The unique identifier of the account that initiated the activity, useful for auditing and tracking purposes.
UserId String False Users.Id No The unique identifier of the user who triggered the activity, enabling user-specific analysis and reporting.
CreatedAt Datetime False No The timestamp indicating when the activity event occurred, formatted in datetime.
Data String False No A serialized string representation of the item's column values at the time of the event.
Entity String False No Specifies the entity affected by the event, such as a 'pulse' (task) or 'board' (project).
Event String False No Describes the specific action that occurred, such as an Update, Delete, or Create operation.
ColumnId String False No The unique identifier of the column affected by the activity, used for filtering and analysis.
GroupId String False Groups.Id No The unique identifier of the group within the board affected by the activity, used for context or filtering.
ItemId String False No The unique identifier of the item (task or object) within the board affected by the activity, used for detailed tracking and filtering.

Return to Top

Assets

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier assigned to the file in the system for tracking and referencing purposes.
Name String False No The name of the file, as specified during upload or creation.
CreatedAt Datetime False No The date and time when the file was created or uploaded, stored in datetime format.
FileExtension String False No The file extension indicating the format or type of the file, such as '.jpg', '.png', or '.pdf'.
FileSize Int False No The size of the file in bytes, providing an indication of storage usage.
OriginalGeometry String False No The original dimensions or geometry of the asset, typically used for images or spatial files.
PublicUrl String False No A temporary public URL to access the asset directly. The URL is valid for 1 hour after being generated.
UploadedById String False Users.Id No The unique identifier of the user who uploaded the file to the system.
Url String False No The URL to access and view the asset directly in its original form.
UrlThumbnail String False No The URL to access and view the asset as a thumbnail. This is only available for image files.

Return to Top

BoardDocBlocks

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the block, used to distinguish it from other blocks in the document.
ParentBlockId String False No The unique identifier of the parent block, establishing hierarchical relationships between blocks.
DocId String False BoardDocs.Id No The unique identifier of the document that contains this block.
CreatedById String False Users.Id No The unique identifier of the user who created the block.
Position Double False No The position of the block within the document, used to determine its order.
Content String False No The content of the block, which could include text, media, or other data.
Type String False No Specifies the type of content stored in the block, such as text, image, or table.
CreatedAt Date False No The date when the block was initially created.
UpdatedAt Date False No The date when the block was last updated.
AfterBlockId String False Yes 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.

Return to Top

BoardDocs

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No A unique identifier for the document within the system, ensuring each document is distinctly recognized.
ObjectId String False No The unique identifier of the object associated with this document, linking the document to its parent entity.
WorkspaceId String False Workspaces.Id No 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 No The unique identifier of the user who created the document, allowing for tracking of document ownership.
DocKind String False No Specifies the document's visibility or access type, such as public, private, or shared.
Name String False No The name assigned to the document, used for identification and display purposes.
RelativeUrl String False No The relative URL of the document, specifying its location within the application's directory structure.
Settings String False No A JSON or serialized string containing configuration and settings specific to the document.
Url String False No The direct URL link to access the document, typically used for navigation.
CreatedAt Date False No The date and time when the document was created, stored in the system's standard date format.
ItemId String False Yes The unique identifier for the item associated with this document, linking it to its specific row or record.
ColumnId String False Yes The unique identifier for the column associated with this document, representing its specific attribute or field.

Return to Top

Boards

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No A unique identifier for the board, used to distinguish it from other boards in the system.
CreatorId String False Users.Id No The unique identifier of the user who created the board.
Name String False No The name of the board, representing its primary label or title.
ItemTerminology String False No 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 No The total number of items currently present on the board.
TopGroupId String False Groups.Id No The unique identifier of the top-level group associated with this board.
Description String False No A detailed description or summary of the board's purpose or content.
UpdatedAt Datetime False No The timestamp indicating when the board was last updated.
Type String False No Specifies the type of board object, such as a task board or project board.
Url String False No The direct URL link to access the board.
BoardKind String False No Indicates the kind of board, such as public, private, or shared, determining its visibility and access.
BoardFolderId String False Folders.Id No A unique identifier for the board's folder within the system.
Communication String False No Specifies the communication identifier associated with the board, typically a meeting ID or collaboration reference.
Permissions String False No Defines the permissions or access controls assigned to the board.
TagsIds String False Tags.Id No A comma-separated list of unique identifiers for the tags associated with the board.
State String False No Indicates the current state of the board, such as 'all', 'active', 'archived', or 'deleted'.
WorkspaceId String False Workspaces.Id No The unique identifier of the workspace containing the board. A null value indicates the board belongs to the main workspace.
TemplateId String False Yes Specifies the unique identifier of an optional template used to create the board.
BoardOwnerIds String False Yes An optional, comma-separated list of user IDs representing the owners of the board.
BoardOwnerTeamIds String False Yes An optional, comma-separated list of team IDs representing the owner teams of the board.
BoardSubscriberIds String False Yes An optional, comma-separated list of user IDs representing subscribers to the board.
BoardSubscriberTeamIds String False Yes An optional, comma-separated list of team IDs representing subscriber teams to the board.
Empty Bool False Yes An optional flag indicating whether to create an empty board without any default items.

Return to Top

BoardTeams

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False Teams.Id No A unique identifier for each board team entry, ensuring distinct records in the table.
BoardId [KEY] String False Boards.Id No Represents the unique identifier of the board associated with the team, linking the team to its respective board.
Kind String False No 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.

Return to Top

BoardUsers

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False Users.Id No The unique identifier for the board owner, used to distinguish users associated with different boards.
BoardId [KEY] String False Boards.Id No The unique identifier of the board to which the user is linked. This is used to associate users with specific boards.
Kind String False No 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.

Return to Top

BoardViews

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No A unique identifier for the board view. Used to distinguish this view from others.
BoardId String False Boards.Id No The unique identifier of the board to which this view belongs. Links the view to its parent board.
Name String False No The name of the board view, typically used for identification and display purposes.
Settings String False No The settings for the board view, stored as a string. Includes configurations specific to this view.
Type String False No The type of the board view, indicating its category or functionality (for example, Kanban, Calendar).
ViewSpecificData String False No Additional data specific to this board view. Supported only for form-based views and stored in a string format.
SourceViewId String False No The unique identifier of the template view if this view was created as a duplicate of another view.

Return to Top

Columns

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the column within its associated board. Ensures each column can be referenced individually.
BoardId [KEY] String False Boards.Id No 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 No 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 No Contains the column's settings stored in a serialized string format. These settings define the column's configuration and behavior.
Title String False No The display name or title of the column, used to identify its purpose or content visually.
Description String False No A detailed description of the column's purpose or content. Provides additional context for users.
Type String False No Specifies the type of the column, indicating its role or the kind of data it contains (for example, 'text', 'number', 'date').
Width Int False No Defines the width of the column in terms of pixels or a similar unit. Determines how much screen space the column occupies.
AfterColumnId String False Yes 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.

Return to Top

CustomActivities

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the custom activity, used to reference and distinguish it from other activities in the system.
Type String False No The classification of the custom activity, indicating its role or category within the broader activity framework (for example, 'Workflow', 'Task').
Name String False No The human-readable name of the custom activity, displayed in user interfaces or reports to identify it.
IconId String False No An identifier corresponding to the icon representing the custom activity, used to visually distinguish it in the user interface.
Color String False No The color associated with the custom activity, typically used for visual categorization or to provide a thematic representation in the UI.

Return to Top

DocBlocks

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the block within the document, ensuring each block can be individually referenced and tracked.
ParentBlockId String False No The unique identifier of the block's parent, establishing the hierarchical relationship between blocks in the document structure.
DocId String False Docs.Id No 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 No 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 No 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 No 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 No 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.
CreatedAt Date False No The date and time when the block was created, providing a timestamp for when it was initially added to the document.
UpdatedAt Date False No The date and time when the block was last modified, tracking when changes were made to the block's content or attributes.
AfterBlockId String False Yes 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.

Return to Top

Docs

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No A unique identifier assigned to the document, used to reference and distinguish the document in the system.
DocFolderId String False Folders.Id No 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 No 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 No 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 No The unique identifier of the user who created the document, linking it to the creator's profile for tracking purposes.
DocKind String False No Specifies the document's classification: public (accessible to all), private (restricted access), or shared (accessible to specific users).
Name String False No The name or title of the document, typically used to identify it within the system or user interface.
RelativeUrl String False No The relative URL path of the document, which can be used to access it within the web application's context.
Settings String False No Stores configuration settings or preferences associated with the document, such as display or security settings.
Url String False No The direct, fully qualified URL that provides access to the document, usable for linking or direct access via a browser.
CreatedAt Date False No The timestamp representing when the document was created, useful for auditing and sorting documents chronologically.

Return to Top

Folders

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No A unique identifier for the folder, used to reference the folder in the system or database.
OwnerId String False Users.Id No The unique identifier of the user who owns the folder, linking it to the user profile responsible for the folder.
ParentId String False No 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 No A list of unique identifiers for the subfolders contained within the current folder, enabling a nested folder structure.
WorkspaceId String False Workspaces.Id No 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 No The color assigned to the folder for visual identification or categorization, often used to visually differentiate between folders in the user interface.
Name String False No The name given to the folder, typically representing its content or purpose, and displayed in the system for easy identification.
CreatedAt Datetime False No The timestamp of when the folder was created, which helps track the folder's age and historical changes.

Return to Top

Groups

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier assigned to the group within the system, ensuring that each group can be referenced distinctly.
BoardId [KEY] String False Boards.Id No The unique identifier of the board to which the group belongs, linking the group to a specific board in the database.
BoardURL String False No The URL of the board associated with the group, providing a direct link for accessing the board in the web interface.
Archived Bool False No 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 No The color associated with the group, typically used for visual identification or categorization within the board.
Deleted Bool False No 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 No A string representing the position of the group on the board, often used for ordering groups in a list or layout.
Title String False No The title or name of the group, which provides a human-readable identifier for the group within the board.
RelativeTo String False Yes Specifies the group relative to which the current group's position should be set. This helps in defining the ordering between groups.
PositionRelativeMethod String False Yes Describes the method used to determine the group's position relative to another group. Possible values include 'before_at' and 'after_at'.
RelativePositionAfter String False Yes 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 False Yes Defines the position of the group relative to another group, specifying that it should appear before the referenced group on the board.

Return to Top

Tags

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the tag, used to reference and distinguish it across the system.
Color String False No The color associated with the tag, which may be used to visually categorize or highlight the tag in the user interface.
Name String False No The name of the tag, typically used to describe or categorize items, and displayed in the user interface.
IsPrivate Bool False No Indicates whether the tag is private (visible only to specific users or groups) or public (accessible to everyone in the system).
BoardId String False No The identifier for a private board where the tag is created or filtered, relevant only for private boards, and not required for public boards.

Return to Top

Teams

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No 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 False No 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 False No 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.

Return to Top

TeamUsers

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False Users.Id No 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 No A unique identifier for the team to which the user is assigned, enabling team-based filtering and operations within the platform.

Return to Top

TimelineItems

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the timeline item, used to reference and track this specific item across the system.
Type String False No Indicates the type of the timeline item, which helps categorize the item (for example task, event, milestone).
Title String False No The title or brief name of the timeline item, providing a summary of its purpose or content.
CustomActivityId String False No The external identifier associated with a custom activity related to the timeline item, useful for integrating with other systems or tools.
UserId String False No The unique identifier of the user who created the timeline item, linking it to a specific user in the system.
UserName String False No The name of the user who created the timeline item, providing context to identify the creator.
ItemId String False No 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 No 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 No The name of the board where the timeline item resides, providing more readable context about the item's location.
BoardWorkspaceId String False No The unique identifier of the workspace where the board resides, helping to categorize the board within a specific workspace or team.
BoardWorkspaceName String False No The name of the workspace associated with the board, offering a human-readable context of where the board is located.
Summary String False Yes A brief summary or overview of the timeline item, typically used to provide a high-level description of the item.
Content String False Yes The detailed content or description of the timeline item, which could include notes, tasks, or additional context about the item.
Location String False Yes The location associated with the timeline item, such as an address, region, or venue, providing geographic context.
Phone String False Yes The phone number associated with the timeline item, often used for contact purposes related to the item.
Url String False Yes A URL linked to the timeline item, such as a related document, website, or resource for further information.
Timestamp Datetime False Yes The creation time of the event associated with the timeline item, used to track when the item was created or modified.
TimeRangeStartTimestamp Datetime False Yes The starting timestamp for a time range associated with the timeline item, such as the beginning of a scheduled event or activity.
TimeRangeEndTimestamp Datetime False Yes The ending timestamp for a time range associated with the timeline item, marking the conclusion of a scheduled event or activity.

Return to Top

Updates

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the update, ensuring each update can be individually referenced and tracked in the database.
Body String False No The HTML-formatted content of the update, which may include various HTML tags for styling and media embedding.
CreatedAt Datetime False No The timestamp when the update was first created, providing the exact date and time of its creation.
CreatorId String False Users.Id No The unique identifier of the user who created the update, enabling tracking of authorship and accountability.
ItemId String False No The unique identifier for the item associated with the update, linking it to the corresponding item in the database.
PinnedToTopItemIds String False No 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 No The plain-text content of the update, providing the core message without any HTML formatting.
UpdatedAt Datetime False No The timestamp when the update was last modified, tracking any subsequent changes after the original creation.
AssetsIds String False Assets.Id No A comma-separated list of unique identifiers for the files or assets attached to the update, such as images or documents.
Replies String False No A list of replies associated with the update, typically stored as a comma-separated list of reply IDs or user responses.
Reactions String False No A data field that tracks user reactions to the update, which can include likes, emojis, or other forms of engagement.
BoardId String False No The unique identifier for the board to which the update belongs, allowing for filtering updates by specific boards or categories.
ParentId String False Yes The unique identifier of the parent update, used for creating threaded discussions or replies related to the original update.

Return to Top

Users

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the user, used to reference the user across the system.
TeamsIds String False No A list of unique identifiers for the teams the user belongs to, helping to track user membership within teams.
Name String False No The full name of the user, used for identification and display purposes.
Phone String False No The user's primary phone number, used for contact and verification.
Birthday Date False No The user's birthdate, which can be used for age verification or personalization.
CurrentLanguage String False No The language currently selected by the user for their interface preferences.
CountryCode String False No The two-letter country code of the user's location, based on their country of residence.
CreatedAt Datetime False No The timestamp for when the user account was created, used for tracking account age and activity.
LastActivity Datetime False No The most recent date and time when the user was active, providing insight into user engagement.
Email String False No The user's email address, used for communication, notifications, and account recovery.
Enabled Bool False No Indicates whether the user account is currently active and able to perform actions.
IsAdmin Bool False No Indicates if the user has administrative privileges and can manage account settings and users.
IsGuest Bool False No Indicates if the user has guest access, typically with restricted permissions.
IsPending Bool False No Indicates whether the user account is pending approval or activation.
IsVerified Bool False No Indicates if the user has verified their email address, confirming their identity.
IsViewOnly Bool False No Indicates if the user has view-only access, meaning they can view but not modify data.
JoinDate Date False No The date when the user first joined the account, useful for understanding user tenure.
Location String False No The geographic location of the user, which may affect settings like time zone or language.
MobilePhone String False No The user's mobile phone number, used for notifications or secondary contact.
PhotoOriginal String False No The URL for the user's photo in its original size, typically used in larger display contexts.
PhotoSmall String False No The URL for the user's photo in a smaller size (150x150), suitable for smaller profile views.
PhotoThumb String False No The URL for the user's thumbnail photo (100x100), used in list views and smaller displays.
PhotoThumbSmall String False No The URL for the user's small thumbnail photo (50x50), typically used for icons or minimal views.
PhotoTiny String False No The URL for the user's tiny photo (30x30), used for extremely small icons or visual references.
TimeZoneIdentifier String False No The user's time zone identifier, used for scheduling and displaying time-related information.
Title String False No The user's job title or designation, providing context about their role within the organization.
Url String False No The URL to the user's profile page, typically used for linking to the user's detailed information.
UtcHoursDiff Int False No The difference in hours between the user's local time and UTC, used for adjusting timestamps and scheduling.
SignUpProductKind String False No The product or service that the user initially signed up for, helping to categorize user plans.
AccountFirstDayOfTheWeek String False No The day of the week (Sunday or Monday) designated as the start of the week for the account, affecting calendar views.
AccountId String False No The unique identifier for the account to which the user belongs, used to associate users with specific accounts.
AccountLogo String False No The URL for the account's logo, displayed in the UI to represent the account.
AccountName String False No The name of the account, used to identify the account in the system.
AccountPlanMaxUsers Int False No The maximum number of users allowed under the current account plan, indicating the plan's user capacity.
AccountPlanPeriod String False No The duration of the account's plan (for example, monthly, annually), which helps track billing cycles.
AccountPlanTier String False No The tier of the account's subscription plan (for example, Basic, Premium), defining the features available.
AccountPlanVersion Int False No The version number of the current plan, useful for tracking plan changes over time.
AccountShowTimelineWeekends Bool False No Indicates whether weekends are included in the account's timeline views.
AccountSlug String False No A URL-friendly version of the account name, typically used for the account's web address or identifier.
AccountTier String False No The account's subscription tier, which determines available features and limitations.
AccountCountryCode String False No The two-letter ISO 3166 country code for the account's registered country, helping to localize settings.
AccountSignUpProductKind String False No The product or service the account initially signed up for, which may determine the account's default settings.
AccountProducts String False No A list of active products or services associated with the account, showing the account's current offerings.
OutOfOfficeActive Bool False No Indicates whether the user's out-of-office status is currently active, affecting their availability.
OutOfOfficeDisableNotifications Bool False No Indicates if notifications are disabled while the user is out of office.
OutOfOfficeStartDate Date False No The date when the user's out-of-office status began, marking the start of their absence.
OutOfOfficeEndDate Date False No The date when the user's out-of-office status ends, marking the return to active status.
OutOfOfficeType String False No The type of out-of-office status, such as vacation or personal leave, used to specify the reason for absence.
NonActive Bool False No Indicates whether non-active users should be included in account queries, useful for generating reports on inactive users.

Return to Top

Webhooks

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the webhook, used to distinguish it from other webhooks in the system.
BoardId String False No The unique identifier for the board associated with the webhook, helping to identify which board the webhook is tied to.
Config String False No A JSON or similar configuration format detailing the settings and preferences for the webhook, including event types, filters, and other parameters.
Event String False No The specific event or trigger that the webhook listens to, such as a change in status or a new task being created.
AppWebhooksOnly Bool False No A filter to include only webhooks created by the application initiating the request, excluding any manually created or external webhooks.
Url String False Yes The URL to which the webhook sends its notifications, typically used to deliver event data to a specified endpoint.

Return to Top

Workspaces

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier for the workspace, used to distinguish it from other workspaces within the platform.
Description String False No A brief textual description of the workspace, providing context or details about its purpose or contents.
Kind String False No Indicates whether the workspace is currently open or closed, helping to categorize the workspace's availability.
Name String False No The name assigned to the workspace, typically used for identification in the user interface.
State String False No Describes the current state of the workspace, which can be 'all', 'active', 'archived', or 'deleted', indicating its lifecycle status.
CreatedAt Datetime False No The timestamp representing when the workspace was initially created, useful for auditing and time-based queries.
AccountProductId String False No The identifier for the specific product associated with the account, linking the workspace to its product type or plan.
AccountProductKind String False No Specifies the type of product tied to the account, such as core, marketing, CRM, software, project management, forms, or whiteboard.
SettingsIconColor String False No 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 No 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 No 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 No The URL associated with the workspace, providing direct access or linking to resources or data within the workspace.

Return to Top

WorkspaceTeams

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No 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 No 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 No 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.

Return to Top

WorkspaceUsers

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier assigned to each user, used to distinguish between different users within the system.
WorkspaceId [KEY] String False No The unique identifier for the workspace to which the user belongs, linking the user to a specific workspace or project.
Kind String False No 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.

Return to Top