Other types

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.

FieldDescriptionEnum values
default_workspace_id IDThe product'sThe account product's default workspace ID.
id IDThe unique identifier of the account product.
kind AccountProductKindThe 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.

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.

FieldDescriptionEnum values

code ActivateUsersErrorCode

The error code that occurred.

CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND

message String

The error message.

user_id 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.

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.

FieldDescriptionEnum values

code AssignTeamOwnersErrorCode

The 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 String

The error message.

user_id 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.

FieldDescription
account_id StringThe unique identifier of the account associated with the event
activity_metadata JSONAdditional metadata about the audit log activity.
client_name StringThe name of the browser used during the event.
client_version StringThe version of the browser used during the event.
device_name StringThe name of the device from which the activity originated.
device_type StringThe type of device from which the activity originated.
event StringThe audit log event. You can view a list of supported events by querying the audit_event_catalogue object.
ip_address StringThe IP address from which the activity originated.
os_name StringThe operating system name on the user's device.
os_version StringThe operating system version on the user's device.
slug StringThe account slug.
timestamp StringThe date and time of the audit log event.
user UserThe user who did the audit log event.
user_agent StringThe 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.

FieldDescription
has_more_pages BooleanReturns true if there are more available pages.
next_page_number IntThe next page number.
page IntThe current page number.
page_size IntThe 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.

FieldDescriptionSupported fields

account_product_id ID

The board's updated account product ID. You must also provide the relevant workspace_id within the updated product.

folder_id ID

The board's updated folder ID.

position DynamicPosition

The board's updated position in the left-side menu.

is_after Boolean
object_id String!
object_type ObjectType!

workspace_id ID

The board's updated workspace ID.

Dynamic position

The board's updated position in the left-side menu of the platform.

FieldDescriptionEnum values

is_after Boolean

Specifies where to position the target board relative to the reference object:

  • Set to true to place the target after the reference
  • Set to false to place the target before the reference

object_id String!

The unique identifier of the reference object that the target board should be positioned relative to.

object_type ObjectType!

The type of the reference object.

Board
Folder
Overview

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

FieldDescription
board BoardThe updated board.
message StringA 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.

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

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.

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.

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.

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.

FieldDescriptionEnum values

code DeactivateUsersErrorCode

The error code that occurred.

CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND

message String

The error message.

user_id 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.

FieldDescriptionEnum values

is_after Boolean

Specifies where to position the target folder relative to the reference object:

  • Set to true to place the target after the reference
  • Set to false to place the target before the reference

object_id String!

The unique identifier of the reference object that the target folder should be positioned relative to.

object_type ObjectType!

The type of the reference object.

Board
Folder
Overview


Invite users result

The InviteUsersResult type contains fields that show the result of inviting a user through the invite_users mutation.

FieldDescription
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.

FieldDescriptionEnum values
code InviteUsersErrorCodeThe error code that occurred.ERROR
message StringThe error message.
email IDThe 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.

FieldDescription
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.

FieldsDescriptionEnum values

created_at Date

The like's creation date.

creator User

The user that liked the update.

creator_id String

The unique identifier of the user that liked the update.

id ID!

The like's unique identifier.

reaction_type ReactionType

The reaction type.

Clap
Happy
Like
Love
PlusOne
Rocks
Trophy
Wow

updated_at Date

The 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.

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.

FieldDescriptionSupported fields

labels [DropdownLabel!]

An array containing the settings of the managed dropdown column's labels.

id Int
is_deactivated Boolean
label String

type ManagedColumnTypes

The type of managed column: dropdown or status.

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.

FieldDescription
id IntThe unique identifier of the managed dropdown column's label.
is_deactivated BooleanWhether the managed dropdown column's label is deactivated.
label StringThe 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.

FieldDescriptionSupported 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.

FieldDescription
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.

FieldDescriptionSupported fields

labels [UpdateDropdownLabelInput!]!

An array that specifies the updated managed dropdown column's labels.

id Int
is_deactivated Boolean
label String!

Update dropdown label input

The [UpdateDropdownLabelInput!]! type contains a subset of fields to specify the updated dropdown label's properties.

FieldDescription
id IntThe unique identifier of the existing label to update. Omit it to create a new label.
is_deactivated BooleanWhether 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_grayaquamarineberry
blackishbright_bluebright_green
brownbubblechili_blue
coffeedark_bluedark_indigo
dark_orangedark_purpledark_red
done_greenegg_yolkexplosive
grass_greenindigolavender
lilaclipsticknavy
orchidpeachpecan
purpleriverroyal
saladishskysofia_pink
steelstuck_redsunset
tantealwinter
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.

FieldDescriptionSupported fields

labels [StatusLabel!]

An array containing the settings of the managed status column's labels.

color StatusColumnColors
description String
id Int
index Int
is_deactivated Boolean
is_done Boolean
label String

type ManagedColumnTypes

The type of managed column: dropdown or status.

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.

FieldDescription
color StatusColumnColorsThe status label's color. See the complete list of available colors here.
description StringThe status label's description.
id IntThe status label's unique identifier.
index IntThe status label's index.
is_deactivated BooleanWhether the status label is deactivated.
is_done BooleanWhether the status label is "Done".
label StringThe 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.

FieldDescriptionSupported fields

labels [CreateStatusLabelInput!]!

An array that defines the new managed status column's labels.

color StatusColumnColors!
description String
index Int!
is_done Boolean
label String!

Create status label input

The [CreateStatusLabelInput!]! type contains a subset of fields to specify the new properties of the managed status column's label.

FieldDescription
color StatusColumnColors!The color of the new managed status column's label. See the complete list of available colors here.
description StringThe new managed status column's description.
index Int!The index of the new managed status column's label.
is_done BooleanWhether 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.

FieldDescriptionSupported fields

labels [UpdateStatusLabelInput!]!

An array that defines the updated managed status column's labels.

color StatusColumnColors!
description String
id Int
index Int!
is_done Boolean
label String!

Update status label input

The [UpdateStatusLabelInput!]! type contains a subset of fields to specify the updated status label's properties.

FieldDescription
color StatusColumnColors!The updated color of the managed status column's label.
description StringThe managed status column's updated description.
id IntThe 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 BooleanWhether the status label is deactivated.
is_done BooleanWhether 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.

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 Kind

The type of entity.

person
team


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.

FieldDescriptionSupported fields

by_app [PlatformApiDailyAnalyticsByApp!]!

The API usage per app.

api_app_id String!
app AppType
usage Int!

by_day [PlatformApiDailyAnalyticsByDay!]!

The API usage per day.

day String!
usage Int!

by_user [PlatformApiDailyAnalyticsByUser!]!

The daily API usage per user.

usage Int!
user User!

last_updatedISO8601DateTime

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.

FieldDescriptionSupported fields

api_app_id ID!

The app's unique API consumer identifier.

app AppType

Metadata about the top six apps with the highest API consumption.

api_app_id ID
client_id String
created_at Date
features [AppFeatureType!]
id ID!
kind String
name String
state String
updated_at Date
user_id ID

usage Int!

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.

FieldDescription
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.

FieldDescription
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 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.

Remove team owners result

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

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.

FieldDescriptionEnum values

code RemoveTeamOwnersErrorCode

The 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 String

The error message.

user_id 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.

FieldDescriptionEnum values

edit_permissions BoardEditPermissions!

Specifies which group of users is allowed to edit the board’s content. This setting reflects the board's technical editing permissions.

assignee
collaborators
everyone
owners

failed_actions [String!]

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.

FieldDescription
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.

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 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.

FieldDescriptionEnum values

id ID!

The unique identifier of the board, project, team, or user to mention.

type MentionType!

The type of entity to mention.

Board
Project
Team
User


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.

FieldDescription
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.

FieldDescription
birthday StringThe user's updated birthday. Use YYYY-MM-DD format.
department StringThe user's updated department.
email StringThe user's updated email.
join_date StringThe user's updated join date. Use YYYY-MM-DD format.
location StringThe user's updated location.
mobile_phone StringThe user's updated mobile phone number.
name StringThe user's updated name.
phone StringThe user's updated phone number.
title StringThe 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.

FieldDescription
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.

FieldDescriptionEnum values
code UpdateUserAttributesErrorCodeThe error code.INVALID_FIELD
message StringThe error message.
user_id IDThe 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.

FieldDescription
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.

FieldDescription
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.

FieldDescriptionEnum values

code UpdateEmailDomainErrorCode

The error code that occurred.

CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
UPDATE_EMAIL_DOMAIN_ERROR
USER_NOT_FOUND

message String

The error message.

user_id 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.

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.

FieldDescriptionEnum values

code UpdateUsersRoleErrorCode

The error code that occurred.

CANNOT_UPDATE_SELF
EXCEEDS_BATCH_LIMIT
FAILED
INVALID_INPUT
USER_NOT_FOUND

message String

The error message.

user_id 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.

FieldDescriptionEnum values

account_product_id ID

The unique identifier of the target account product to move the workspace to. You can retrieve this by querying the account object. **Only available in versions 2025-10 and later. **

description String

The updated workspace description.

kind WorkspaceKind

The kind of workspace to update.

closed
open

name String

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.

FieldDescriptionSupported fields

icon WorkspaceIcon

The 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).