Learn about other types supported by the monday platform API
Account product
The AccountProduct type is used as a field on account queries. It contains a set of fields that return metadata about the account's products.
| Field | Description | Enum values |
|---|---|---|
default_workspace_id ID | The product's | The account product's default workspace ID. |
id ID | The unique identifier of the account product. | |
kind AccountProductKind | The account product. | core, crm, forms, marketing, 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.
| Field | Description | Supported fields |
|---|---|---|
activated_users | The users that were activated. | |
errors | The errors that occurred while activating users. Use this field to check for calls that failed. | code |
Activate users error
The ActivateUsersError type contains a subset of fields to describe the error that occurred when a activate_users mutation fails.
| Field | Description | Enum values |
|---|---|---|
code | The error code that occurred. |
|
message | The error message. | |
user_id | The 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.
| Field | Description |
|---|---|
errors [AssignTeamOwnersError!] | The errors that occurred while assigning owners to a team. Use this field to check for calls that failed. |
team Team | The 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.
| Field | Description | Enum values |
|---|---|---|
code | The error code that occurred. |
|
message | The error message. | |
user_id | The unique identifier of the user that caused the error. |
Audit logs
Account admins can retrieve audit log activity by querying the audit_logs object.
Audit log entry
The [AuditLogEntry!] type is used as a field on audit_logs queries. It contains a set of fields that return metadata about the audit log's entries.
| Field | Description |
|---|---|
account_id String | The unique identifier of the account associated with the event |
activity_metadata JSON | Additional metadata about the audit log activity. |
client_name String | The name of the browser used during the event. |
client_version String | The version of the browser used during the event. |
device_name String | The name of the device from which the activity originated. |
device_type String | The type of device from which the activity originated. |
event String | The audit log event. You can view a list of supported events by querying the audit_event_catalogue object. |
ip_address String | The IP address from which the activity originated. |
os_name String | The operating system name on the user's device. |
os_version String | The operating system version on the user's device. |
slug String | The account slug. |
timestamp String | The date and time of the audit log event. |
user User | The user who did the audit log event. |
user_agent String | The user agent string of the client or browser. |
Pagination
The Pagination type is used as a field on audit_logs queries. It contains a set of fields that return metadata about the audit log's pagination.
| Field | Description |
|---|---|
has_more_pages Boolean | Returns true if there are more available pages. |
next_page_number Int | The next page number. |
page Int | The current page number. |
page_size Int | The number of requested items per page. |
Boards
Update board hierarchy attributes input
The UpdateBoardHierarchyAttributesInput! type is an argument on the update_board_hierarchy mutation that defines the board's attributes to update.
| Field | Description | Supported fields |
|---|---|---|
account_product_id | The board's updated account product ID. You must also provide the relevant | |
folder_id | The board's updated folder ID. | |
position | The board's updated position in the left-side menu. | is_after |
workspace_id | The board's updated workspace ID. |
Dynamic position
The board's updated position in the left-side menu of the platform.
| Field | Description | Enum values |
|---|---|---|
is_after | Specifies where to position the target board relative to the reference object:
| |
object_id | The unique identifier of the reference object that the target board should be positioned relative to. | |
object_type | The type of the reference object. |
|
Update board hierarchy result
The UpdateBoardHierarchyResult type contains fields that show the result of updating a board's position, product, or workspace via the update_board_hierarchy mutation.
🚧 Only available in API versions 2025-10 and later
| Field | Description |
|---|---|
board Board | The updated board. |
message String | A message about the operation's result. |
success Boolean! | Whether the operation was successful. |
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.
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.
| Field | Description |
|---|---|
is_guest_team Boolean | Whether or not the new team contains guest users. |
name String! | The new team's name. |
parent_team_id ID | The 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.
| Field | Description |
|---|---|
allow_empty_team Boolean | Whether 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.
| Field | Description |
|---|---|
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.
| Field | Description | Enum values |
|---|---|---|
code | The error code that occurred. |
|
message | The error message. | |
user_id | The unique identifier of the user that caused the error. |
Folders
Dynamic position
The DynamicPosition type is an argument on the update_folder mutation that defines the folder's updated location in the left-side menu of the platform.
| Field | Description | Enum values |
|---|---|---|
is_after | Specifies where to position the target folder relative to the reference object:
| |
object_id | The unique identifier of the reference object that the target folder should be positioned relative to. | |
object_type | The type of the reference object. |
|
Invite users result
The InviteUsersResult type contains fields that show the result of inviting a user through the invite_users mutation.
| Field | Description |
|---|---|
invited_users [User!] | Data from the users that were successfully invited. |
errors [InviteUsersError!] | The errors that occurred while inviting users. Use this field to check for calls that failed. |
Invite users error
The InviteUsersError type contains a subset of fields to describe the error that occurred when an invite_users mutation fails.
| Field | Description | Enum values |
|---|---|---|
code InviteUsersErrorCode | The error code that occurred. | ERROR |
message String | The error message. | |
email ID | The email 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.
| Field | Description |
|---|---|
column_id String! | The IDs of the specific columns to return results for. |
column_values [String]! | The column values to filter items by. |
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.
| Fields | Description | Enum values |
|---|---|---|
created_at | The like's creation date. | |
creator | The user that liked the update. | |
creator_id | The unique identifier of the user that liked the update. | |
id | The like's unique identifier. | |
reaction_type | The reaction type. |
|
updated_at | The like's last updated date. |
Linked items
The linked_items field returns an item's linked items on an items query.
| Arguments | Description |
|---|---|
linked_board_id Int! | The linked board's unique identifier. |
link_to_item_column_id String! | The link to item column's unique identifier. |
Managed columns
Managed columns are useful tools to standardize workflows across your monday.com account. Select users can create, own, and manage status and dropdown columns with predefined labels that can't be edited by other members. This ensures consistent terminology across different workflows and helps align teams on a unified structure.
Users with managed column permissions can read, create, activate, update, deactivate, and deleted managed dropdown and status columns via the API.
Dropdown
Dropdown column settings
DropdownColumnSettings is one of two possible GraphQL implementation types for a managed column's settings field. It includes a subset of fields that return the configuration of a managed dropdown column.
| Field | Description | Supported fields |
|---|---|---|
labels | An array containing the settings of the managed dropdown column's labels. | id |
type | The type of managed column: |
Dropdown label
The DropdownLabel type defines the individual labels used in a managed dropdown column. Each label includes details such as display text, ID, and status.
| Field | Description |
|---|---|
id Int | The unique identifier of the managed dropdown column's label. |
is_deactivated Boolean | Whether the managed dropdown column's label is deactivated. |
label String | The managed dropdown column label's text. |
Create dropdown column settings input
The CreateDropdownColumnSettingsInput type is used as an argument on the create_dropdown_managed_column mutation. It contains one field used to define the properties of the new managed dropdown column's labels.
| Field | Description | Supported fields |
|---|---|---|
labels [CreateDropdownLabelInput!]! | An array that specifies the new managed dropdown column's labels. | label String! |
Create dropdown label input
The [CreateDropdownLabelInput!]! type contains a one field to specify the new properties of the managed dropdown column's label.
| Field | Description |
|---|---|
label String! | The text on the new managed dropdown column's label. |
Update dropdown column settings input
The UpdateDropdownColumnSettingsInput type is used as an argument on the update_dropdown_managed_column mutation. It contains one field used to define the updated managed dropdown column label's properties.
| Field | Description | Supported fields |
|---|---|---|
labels | An array that specifies the updated managed dropdown column's labels. | id |
Update dropdown label input
The [UpdateDropdownLabelInput!]! type contains a subset of fields to specify the updated dropdown label's properties.
| Field | Description |
|---|---|
id Int | The unique identifier of the existing label to update. Omit it to create a new label. |
is_deactivated Boolean | Whether the label is deactivated. |
label String! | The managed dropdown column's updated label. |
Status
Status column colors
The StatusColumnColors type is used to specify and identify a managed status column's label color. You can find a list of each value and its corresponding color here.
| Enum values | ||
|---|---|---|
american_gray | aquamarine | berry |
blackish | bright_blue | bright_green |
brown | bubble | chili_blue |
coffee | dark_blue | dark_indigo |
dark_orange | dark_purple | dark_red |
done_green | egg_yolk | explosive |
grass_green | indigo | lavender |
lilac | lipstick | navy |
orchid | peach | pecan |
purple | river | royal |
saladish | sky | sofia_pink |
steel | stuck_red | sunset |
tan | teal | winter |
working_orange |
Status column settings
StatusColumnSettings is one of two possible GraphQL implementation types for a managed column's settings field. It includes a subset of fields that return the configuration of a managed status column.
| Field | Description | Supported fields |
|---|---|---|
labels | An array containing the settings of the managed status column's labels. | color |
type | The type of managed column: |
Status label
The StatusLabel type defines the individual labels used in a managed status column. Each label includes details such as color, display text, and status.
| Field | Description |
|---|---|
color StatusColumnColors | The status label's color. See the complete list of available colors here. |
description String | The status label's description. |
id Int | The status label's unique identifier. |
index Int | The status label's index. |
is_deactivated Boolean | Whether the status label is deactivated. |
is_done Boolean | Whether the status label is "Done". |
label String | The status label's text. |
Create status column settings input
The CreateStatusColumnSettingsInput type is used as an argument on the create_status_managed_column mutation. It contains one field used to define the properties of the new managed status column's labels.
| Field | Description | Supported fields |
|---|---|---|
labels | An array that defines the new managed status column's labels. | color |
Create status label input
The [CreateStatusLabelInput!]! type contains a subset of fields to specify the new properties of the managed status column's label.
| Field | Description |
|---|---|
color StatusColumnColors! | The color of the new managed status column's label. See the complete list of available colors here. |
description String | The new managed status column's description. |
index Int! | The index of the new managed status column's label. |
is_done Boolean | Whether the label is marked as "Done" |
label String! | The text on the new managed status column's label. |
Update status column settings input
The UpdateStatusColumnSettingsInput type is used as an argument on the update_status_managed_column mutation. It contains one field used to define the properties of the updated managed status column's labels.
| Field | Description | Supported fields |
|---|---|---|
labels | An array that defines the updated managed status column's labels. | color |
Update status label input
The [UpdateStatusLabelInput!]! type contains a subset of fields to specify the updated status label's properties.
| Field | Description |
|---|---|
color StatusColumnColors! | The updated color of the managed status column's label. |
description String | The managed status column's updated description. |
id Int | The unique identifier of the existing label to update. Omit it to create a new label. |
index Int! | The updated index of the new managed status column's label. |
is_deactivated Boolean | Whether the status label is deactivated. |
is_done Boolean | Whether the label is marked as "Done" |
label String! | The updated text on the new managed status column's label. |
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.
| Fields | Description | Possible 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 MirroredValue | The 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 values | Description |
|---|---|
| left | The symbol is placed to the left of the number. |
| right | The 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.
| Field | Description | Enum values |
|---|---|---|
id | The unique identifier of the person or team. | |
kind | The type of entity. |
|
Platform API daily analytics
The daily_analytics field on platform_API queries returns metadata about an account's daily API consumption. It includes fields to sort data by app, day, user, or view the last updated timestamp.
| Field | Description | Supported fields |
|---|---|---|
The API usage per app. | api_app_id | |
The API usage per day. | day | |
The daily API usage per user. | usage | |
last_updated | The timestamp of when the API usage data was last updated. |
By app
The [PlatformApiDailyAnalyticsByApp!]! type is used as a field on platform API daily_analytics queries. It returns API consumption data for the top six apps over the past 14 days.
| Field | Description | Supported fields |
|---|---|---|
api_app_id | The app's unique API consumer identifier. | |
app | Metadata about the top six apps with the highest API consumption. | api_app_id |
usage | The API amount consumed by a given app in the past 14 days. |
By day
The [PlatformApiDailyAnalyticsByDay!]! type is used as a field on platform API daily_analytics queries. It returns details about API usage per day over the past 14 days.
| Field | Description |
|---|---|
day String! | The day. |
usage Int! | The amount consumed on a given day. |
By user
The [PlatformApiDailyAnalyticsByUser!]! type is used as a field on daily_analytics queries. It returns API consumption data for the top six users over the past 14 days.
| Field | Description |
|---|---|
usage Int! | The API amount consumed by a given user in the past 14 days. |
user User! | Metadata about the top six users with the highest API consumption. |
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 value | Description |
|---|---|
after_at | Creates the new group or item below the relative_to value. |
before_at | Creates the new group or item above the relative_to value. |
Remove team owners result
The RemoveTeamOwnersResult type contains fields that show the result of removing team owners through the remove_team_owners mutation.
| Field | Description |
|---|---|
errors [RemoveTeamOwnersError!] | The errors that occurred while removing owners from a team. Use this field to check for calls that failed. |
team Team | The 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.
| Field | Description | Enum values |
|---|---|---|
code | The error code that occurred. |
|
message | The error message. | |
user_id | The unique identifier of the user that caused the error. |
Set board permission response
The SetBoardPermissionResponse type contains fields that show the result of setting a board's permissions via the set_board_permissions mutation.
| Field | Description | Enum values |
|---|---|---|
edit_permissions | Specifies which group of users is allowed to edit the board’s content. This setting reflects the board's technical editing permissions. |
|
failed_actions | Any actions that failed during the permission update process. |
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.
| Field | Description |
|---|---|
border String! | The label's border Hex color code. |
color String! | The label's Hex color code. |
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.
| Field | Description |
|---|---|
created_at Date! | The date the session was added to the item. |
ended_at Date | The date the session ended. |
ended_user_id ID | The 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 Date | The date the session was started. Only applicable if the session was started by pressing the play button or through an automation. |
started_user_id ID | The unique identifier of the user that started the time tracking. |
status String! | The session's status. |
updated_at Date | The date the session was updated. |
Update mention
The UpdateMention type is used as a field on the create_update mutation. It contains a set of fields that to define the entities mentioned in the update.
| Field | Description | Enum values |
|---|---|---|
id | The unique identifier of the board, project, team, or user to mention. | |
type | The type of entity to mention. |
|
Update users' attributes
User update input
The [UserUpdateInput!]! type is used as an argument on the update_multiple_users mutation and contains fields to specify what attributes to update.
| Field | Description |
|---|---|
user_attribute_updates UserAttributesInput! | The attributes to update. |
user_id ID! | The unique identifier of the user to update. |
User attributes input
The UserAttributesInput! type contains fields to specify what attributes to update.
| Field | Description |
|---|---|
birthday String | The user's updated birthday. Use YYYY-MM-DD format. |
department String | The user's updated department. |
email String | The user's updated email. |
join_date String | The user's updated join date. Use YYYY-MM-DD format. |
location String | The user's updated location. |
mobile_phone String | The user's updated mobile phone number. |
name String | The user's updated name. |
phone String | The user's updated phone number. |
title String | The user's updated title. |
Update user attributes result
The UpdateUserAttributesResult type contains fields that show the result of updating a user's attributes through the update_multiple_users mutation.
| Field | Description |
|---|---|
errors [UpdateUserAttributesError!] | The errors that occurred while updating the user's attributes. Use this field to check for failed calls. |
updated_users [User!] | Data from the users that were updated. |
Update user attributes error
The [UpdateUserAttributesError!] type contains a subset of fields to describe the error that occurred when an update_multiple_users mutation fails.
| Field | Description | Enum values |
|---|---|---|
code UpdateUserAttributesErrorCode | The error code. | INVALID_FIELD |
message String | The error message. | |
user_id ID | The unique identifier of the user that caused the error. |
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.
| Field | Description |
|---|---|
new_domain String! | The updated email domain. |
user_ids [ID!]! | The unique identifiers of the users to update. The maximum is 200. |
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.
| Field | Description |
|---|---|
errors [UpdateEmailDomainError!] | The errors that occurred while updating the email domain. Use this field to check for failed calls. |
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.
| Field | Description | Enum values |
|---|---|---|
code | The error code that occurred. |
|
message | The error message. | |
user_id | The 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.
| Field | Description |
|---|---|
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.
| Field | Description | Enum values |
|---|---|---|
code | The error code that occurred. |
|
message | The error message. | |
user_id | The 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. It contains fields to specify which workspace attributes to update.
| Field | Description | Enum values |
|---|---|---|
account_product_id | The unique identifier of the target account product to move the workspace to. You can retrieve this by querying the | |
description | The updated workspace description. | |
kind | The kind of workspace to update. |
|
name | The 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.
| Field | Description | Supported fields |
|---|---|---|
icon | The workspace's icon. | color |
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.
| Field | Description |
|---|---|
color String | The hex value of the icon's color. Used as a background for the image. |
image String | The temporary public image URL (valid for one hour). |
