Learn about other types supported by the monday platform API

Account product

The AccountProduct type is used as a field on workspaces queries. It contains a set of fields that returns metadata about the account product the queried workspace is in.

FieldDescriptionEnum values
id IntThe unique identifier of the account product.
kind AccountProductKindThe account product.core, crm, forms, marketing, projectManagement, project_management, service, software, whiteboard

Activate users result

The ActivateUsersResult type contains fields that show the result of activating a user through the activate_users mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescriptionSupported fields
activated_users [User!]The users that were activated.
errors [ActivateUsersError!]The errors that occurred while activating users. Use this field to check for calls that failed.code ActivateUsersErrorCode
message String
user_id ID

Activate users error

The ActivateUsersError type contains a subset of fields to describe the error that occurred when a activate_users mutation fails.

🚧

Only available in API versions 2025-01 and later

FieldDescriptionEnum values
code ActivateUsersErrorCodeThe error code that occurred.CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND
message StringThe error message.
user_id IDThe unique identifier of the user that caused the error.

Assign team owners result

The AssignTeamOwnersResult type contains fields that show the result of assigning team owners through the assign_team_owners mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescription
errors [AssignTeamOwnersError!]The errors that occurred while assigning owners to a team. Use this field to check for calls that failed.
team TeamThe team the owners were assigned to.

Assign team owners error

The AssignTeamOwnersError type contains a subset of fields to describe the error that occurred when a assign_team_owners mutation fails.

🚧

Only available in API versions 2025-01 and later

FieldDescriptionEnum values
code AssignTeamOwnersErrorCodeThe error code that occurred.CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND
USER_NOT_MEMBER_OF_TEAM
VIEWERS_OR_GUESTS
message StringThe error message.
user_id IDThe unique identifier of the user that caused the error.

Change team memberships result

The ChangeTeamsMembershipResult type contains fields that show the result of adding or removing users from a team for the add_users_to_team and remove_users_from_team mutations.

FieldDescription
failed_users [User!]The users the team membership update failed for.
successful_users [User!]The users the team membership update succeeded for.

Column mapping input

The ColumnMappingInput type is an argument on the move_items_to_board mutation that defines the column mapping between the target and source boards.

FieldDescription
source ID!The source column's unique identifier.
target IDThe target column's unique identifier.

Column type

ColumnType accepts enum values to specify which column type to filter, read, or update in your query or mutation.

Enum values

auto_number long_text
board_relation mirror
button name
checkbox numbers
color_picker people
country phone
creation_log progress
date rating
dependency status
doc subtasks
dropdown tags
email team
file text
formula timeline
hour time_tracking
item_assignees vote
item_id week
last_updated world_clock
link unsupported
location

Create doc input

The CreateDocInput! type is an argument for the create_doc mutation that contains a set of arguments to specify where to create the new doc.

FieldDescriptionSupported arguments
board CreateDocBoardInputThe new document's location (when creating a doc on a board).column_id String!
item_id ID!
workspace CreateDocWorkspaceInputThe new document's location (when creating a doc in a workspace). kind BoardKind
name String!
workspace_id ID!

Create doc board input

The CreateDocBoardInput type is used to specify the item and column where you want to create the new document.

FieldDescription
column_id String!The unique identifier of the column to create the new doc in.
item_id ID!The unique identifier of the item to create the new doc on.

Create doc workspace input

The CreateDocWorkspaceInput type is used to specify the workspace where you want to create a document and the new document's name and kind.

FieldDescriptionEnum values
kind BoardKindThe kind of document to create.private
public
share
name String!The new document's name.
workspace_id ID!The unique identifier of the workspace to create the new doc in.

Create team

Create team attributes input

The CreateTeamAttributesInput! type is used as an argument on the create_team mutation to specify the characteristics of the new team being created via the API.

🚧

Only available in API versions 2025-01 and later

FieldDescription
is_guest_team BooleanWhether or not the new team contains guest users.
name String!The new team's name.
parent_team_id IDThe parent team's unique identifier.
subscriber_ids [ID!]The team members's unique identifiers. Cannot be empty unless allow_empty_team is set.

Create team options input

The CreateTeamOptionsInput type is used to specify the options when creating a new team via the API.

🚧

Only available in API versions 2025-01 and later

FieldDescription
allow_empty_team BooleanWhether or not the team can have no subscribers.

Deactivate users result

The DeactivateUsersResult type contains fields that show the result of deactivating a user through the deactivate_user mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescription
deactivated_users [User]!Data from the users that were deactivated.
errors [DeactivateUsersError]!The errors that occurred during deactivation. Use this field to check for calls that failed.

Deactivate users error

The DeactivateUsersError type contains a subset of fields to describe the error that occurred when a deactivate_user mutation fails.

🚧

Only available in API versions 2025-01 and later

FieldDescriptionEnum values
code DeactivateUsersErrorCodeThe error code that occurred.CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND
message StringThe error message.
user_id IDThe unique identifier of the user that caused the error.

Items page by column values query

The ItemsPageByColumnValuesQuery type is used as an argument for the items_page_by_column_values object and contains a set of fields used to specify which columns and column values to filter your results by.

FieldDescription
column_id String!The IDs of the specific columns to return results for.
column_values [String]!The column values to filter items by.

Items query

The ItemsQuery type is used as an argument for the items_page object and contains a set of parameters to filter, sort, and control the scope of the boards query.

FieldDescriptionEnum valuesSupported arguments
ids [ID!]The specific item IDs to return. The maximum is 100.
rules [ItemsQueryRule!]The rules to filter your queries.column_id ID!
compare_attribute String
compare_value CompareValue!
operator ItemsQueryRuleOperator
operator ItemsQueryOperatorThe conditions between query rules. The default is and.and or
order_by [ItemsQueryOrderBy!]The attributes to sort results by.column_id String!
direction ItemsOrderByDirection

[ItemsQueryRule!]

The rules to filter your queries.

FieldDescriptionEnum values
column_id ID!The unique identifier of the column to filter by.
compare_attribute StringThe comparison attribute. You can find the supported attributes for each column type in the column types reference. Most columns don't have a compare_attribute.
compare_value CompareValue!The column value to filter by. This can be a string or index value depending on the column type. You can find the supported values for each column type in the column types reference.
operator ItemsQueryRuleOperatorThe condition for value comparison. The default is any_of.any_of
not_any_of
is_empty
is_not_empty
greater_than
greater_than_or_equals
lower_than
lower_than_or_equal
between
not_contains_text
contains_text
contains_terms
starts_with
ends_with
within_the_next
within_the_last

[ItemsQueryOrderBy!]

The attributes to sort results by.

FieldDescriptionEnum values
column_id String!The unique identifier of the column to filter or sort by. You can also enter "__creation_log__" or "__last_updated__" to chronologically sort results by their last updated or creation date (oldest to newest).
direction ItemsOrderByDirectionThe direction to sort items in. The default is asc.asc
desc

Like

The Like type is used as a field on updates queries and contains a set of fields to return details about the update's reactions or likes.

FieldsDescriptionEnum values
created_at DateThe like's creation date.
creator UserThe user that liked the update.
creator_id StringThe unique identifier of the user that liked the update.
id ID!The like's unique identifier.
reaction_type ReactionTypeThe reaction type.Clap
Happy
Like
Love
PlusOne
Rocks
Trophy
Wow
updated_at DateThe like's last updated date.

Linked items

The linked_items field returns an item's linked items on an items query.

ArgumentsDescription
linked_board_id Int!The linked board's unique identifier.
link_to_item_column_id String!The link to item column's unique identifier.

Mirrored item

The MirroredItem type is used as a field on the MirrorValue implementation and contains a set of fields to return details about an item's mirrored items.

FieldsDescriptionPossible types
linked_board Board!The linked board.
linked_board_id ID!The linked board's unique identifier.
linked_item Item!The linked item.
mirrored_value MirroredValueThe mirrored values.Board, BoardRelationValue, ButtonValue, CheckboxValue, ColorPickerValue, CountryValue, CreationLogValue, DateValue, DependencyValue, DocValue, DropdownValue, EmailValue, FileValue, FormulaValue, Group, HourValue, ItemIdValue, LastUpdatedValue, LinkValue, LocationValue, LongTextValue, MirrorValue, NumbersValue, PeopleValue, PhoneValue, ProgressValue, RatingValue, StatusValue, SubtasksValue, TagsValue, TeamValue, TextValue, TimeTrackingValue, TimelineValue, UnsupportedValue, VoteValue, WeekValue, WorldClockValue

Number value unit direction

The NumberValueUnitDirection type is used as a field on the NumbersValue implementation that indicates whether the unit symbol is placed to the right or left of a number value.

Enum valuesDescription
leftThe symbol is placed to the left of the number.
rightThe symbol is placed to the right of the number.

People entity

The PeopleEntity type is used as a field on the PeopleValue implementation that contains the column's people or team values.

FieldDescriptionEnum values
id ID!The unique identifier of the person or team.
kind KindThe type of entity.person
team

Remove team owners result

The RemoveTeamOwnersResult type contains fields that show the result of removing team owners through the remove_team_owners mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescription
errors [RemoveTeamOwnersError!]The errors that occurred while removing owners from a team. Use this field to check for calls that failed.
team TeamThe team the owners were removed from.

Remove team owners error

The RemoveTeamOwnersError type contains a subset of fields to describe the error that occurred when a remove_team_owners mutation fails.

🚧

Only available in API versions 2025-01 and later

FieldDescriptionEnum values
code RemoveTeamOwnersErrorCodeThe error code that occurred.CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND
USER_NOT_MEMBER_OF_TEAM
VIEWERS_OR_GUESTS
message StringThe error message.
user_id IDThe unique identifier of the user that caused the error.

Reply

The Reply type is used as a field on updates queries and contains a set of fields to return details about the update's replies.

FieldsDescriptionSupported fields
body String!The reply's HTML-formatted body.
created_at DateThe reply's creation date.
creator UserThe reply's creator.
creator_id StringThe unique identifier of the reply's creator.
id ID!The reply's unique identifier.
kind String!The reply's kind.
likes [Like!]!The reply's likes. created_at Date
creator User
creator_id String
id ID!
reaction_type String
updated_at Date
pinned_to_top [UpdatePin!]!The reply's pin to top data. item_id ID!
text_body StringThe reply's text body.
updated_at DateThe reply's last updated date.

Status label style

The StatusLabelStyle type is used as a field on the StatusValue implementation. It contains a set of fields that return details about the status label's style.

FieldDescription
border String!The label's border Hex color code.
color String!The label's Hex color code.

Position relative

The PositionRelative type is used as an argument on the create_item and create_group mutations. It contains a set of enum values to determine the location of the item or group being created.

Enum valueDescription
after_atCreates the new group or item below the relative_to value.
before_atCreates the new group or item above the relative_to value.

Time tracking history item

The TimeTrackingHistoryItem type is used as a field on the TimeTrackingValue implementation. It contains a set of fields that returns data about the time tracking column history.

FieldDescription
created_at Date!The date the session was added to the item.
ended_at DateThe date the session ended.
ended_user_id IDThe unique identifier of the user that ended the time tracking.
id ID!The unique session identifier.
manually_entered_end_date Boolean!Returns true if the session end date was manually entered.
manually_entered_end_time Boolean!Returns true if the session end time was manually entered.
manually_entered_start_date Boolean!Returns true if the session start date was manually entered.
manually_entered_start_time Boolean!Returns true if the session start time was manually entered.
started_at DateThe date the session was started. Only applicable if the session was started by pressing the play button or through an automation.
started_user_id IDThe unique identifier of the user that started the time tracking.
status String!The session's status.
updated_at DateThe date the session was updated.

Update user's email domain

Update email domain attributes input

The UpdateEmailDomainAttributesInput type contains fields to specify what attributes to update through the update_email_domain mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescription
new_domain String!The updated email domain.
user_ids [ID!]!The unique identifiers of the users to update. The maximum is 200.

Update email domain options

The UpdateEmailDomainOptions type contains fields to specify what options to update through the update_email_domain mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescription
bypass_confirmation_emails_for_claimed_domains BooleanWhether or not to bypass confirmation emails for claimed domains. Not implemented.

Update user's email domain result

The UpdateUsersEmailDomainResult type contains fields that show the result of updating a user's email domain through the update_email_domain mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescription
errors [UpdateEmailDomainError!]The errors that occurred while updating the email domain. Use this field to check for calls that failed.
updated_users [User!]Data from the users that were updated.

Update email domain error

The UpdateEmailDomainError type contains a subset of fields to describe the error that occurred when an update_email_domain mutation fails.

🚧

Only available in API versions 2025-01 and later

FieldDescriptionEnum values
code UpdateEmailDomainErrorCodeThe error code that occurred.CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
UPDATE_EMAIL_DOMAIN_ERROR
USER_NOT_FOUND
message StringThe error message.
user_id IDThe unique identifier of the user that caused the error.

Update user's role result

The UpdateUsersRoleResult type contains fields that show the result of updating a user's role through the update_users_role mutation.

🚧

Only available in API versions 2025-01 and later

FieldDescription
errors [UpdateUsersRoleError!]The errors that occurred while updating the role. Use this field to check for calls that failed.
updated_users [User]!Data from the users that were updated.

Update user's role error

The UpdateUsersRoleError type contains a subset of fields to describe the error that occurred when an update_users_role mutation fails.

🚧

Only available in API versions 2025-01 and later

FieldDescriptionEnum values
code UpdateUsersRoleErrorCodeThe error code that occurred.CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND
message StringThe error message.
user_id IDThe unique identifier of the user that caused the error.

Update workspace attributes input

The UpdateWorkspaceAttributesInput type is used as an argument on the update_workspace mutation and contains fields to specify what attributes to update.

FieldDescriptionEnum values
description StringThe updated workspace description.
kind WorkspaceKindThe kind of workspace to update. closed
open
name StringThe updated workspace name.

Workspace settings

The WorkspaceSettings type is used as a field on workspaces queries. It supports one field to return data about the workspace's settings.

FieldDescriptionSupported fields
icon WorkspaceIconThe workspace's icon.color String
image String

Workspace icon

The WorkspaceIcon type is used as a field when querying a workspace's settings. It contains a set of fields that returns data about the workspace's icon.

FieldDescription
color StringThe hex value of the icon's color. Used as a background for the image.
image StringThe temporary public image URL (valid for one hour).