Account product

The AccountProduct type is a field on workspaces queries and contains metadata about the account product the queried workspace is in.

Fields

Field	Description	Enum values
id `Int`	The unique identifier of the account product.
kind `AccountProductKind`	The account product.	core, crm, forms, marketing, projectManagement, project_management, service, software, whiteboard

App install account

The AppInstallAccount type is a field on app install queries that contains the app installer's account details.

Fields

Field	Description
id `Int!`	The unique identifier of the app installer's account. Please note that the field type is `ID!` in API versions `2024-04` and later.

App install permissions

The AppInstallPermissions type is a field on app install queries that contains the required and approved scopes for an app installation.

👍
Pro tip
This field is only available in API versions 2024-04 and later.

Fields

Field	Description
approved_scopes `[String!]!`	The scopes approved by the account admin.
required_scopes `[String!]!`	The scopes required by the latest live app version.

App install user

The AppInstallUser type is a field on app install queries that contains the app installer's user details.

Fields

Field	Description
id `Int`	The app installer's unique identifier. Please note that the field type is `ID` in API versions `2024-04` and later.

App version

The AppVersion type is a field on app install queries that contains details about the app version when it was installed.

Fields

Field	Description
major `Int!`	The app's major version.
minor `Int!`	The app's minor version.
patch `Int!`	The app's patch version.
text `String!`	The app's version text.
type `String`	The app's version type.

Batch extend trial period

The batch_extend_trial_period mutation enables apps monetized by monday to provide trial extensions for up to five accounts through the API.

This mutation will only work for app collaborators and will fail if you do not have the correct permissions.

mutation {
  batch_extend_trial_period (account_slugs: ["test", "monday"], app_id: 12345678, plan_id: "Plan_1", duration_in_days: 21) {
    details {
      account_slug
      reason
      success
    }
    reason
    success
  }
}

Arguments

Argument	Description
account_slugs `[String!]!`	The account slug(s) to provide trial extensions for. The maximum is 5.
app_id `ID!`	The unique identifier of the application.
duration_in_days `Int!`	The number of days to extend the trial. The maximum is 365. Please note that you must make multiple calls if the account slugs require different durations.
plan_id `String!`	The unique identifier of the payment plan.

Fields

Field	Description
details `[ExtendTrialPeriod!]`	The details of the batch operation.
reason `String`	The reason the operation resulted in an error. Please note that this will return an empty string if the operation is successful.
success `Boolean!`	The result of the batch operation. Please note that when providing extensions to multiple account slugs, this will return `false` whenever even one of the operations fails.

Extend trial period

The ExtendTrialPeriod type is a field on the batch_extend_trial_period mutation that provides details about a single operation from the batch.

Fields

Field	Description
account_slug `String!`	The individual account slug.
reason `String`	The reason the single operation resulted in an error. Please note that this will return `null` if the operation is successful.
success `Boolean!`	The result of the single operation.

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.

mutation {
  add_users_to_team (team_id: 7654321, user_ids: [123456, 654321, 012345]) {
    successful_users {
      name
      email 
    }
    failed_users {
      name
      email
    }
  }
}

Fields

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

Fields

Field	Description
source `ID!`	The source column's unique identifier.
target `ID`	The 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
board_relation
button
checkbox
color_picker
country
creation_log
date
dependency
doc
dropdown
email
file
formula
hour
item_assignees
item_id
last_updated
link
location
long_text
mirror
name
numbers
people
phone
progress
rating
status
subtasks
tags
team
text
timeline
time_tracking
vote
week
world_clock
unsupported

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.

Fields

Field	Description	Supported arguments
board `CreateDocBoardInput`	The new document's location (when creating a doc on a board).	column_id `String!` item_id `ID!`
workspace `CreateDocWorkspaceInput`	The 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.

Fields

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

Fields

Field	Description
kind `BoardKind`	The kind of document to create: public, private, or share.
name `String!`	The new document's name.
workspace_id `ID!`	The unique identifier of the workspace to create the new doc in.

Delete marketplace app discount

The DeleteMarketplaceAppDiscount! type returns metadata for recently deleted marketplace app discounts.

🚧
Only available in API versions 2024-10 and later

Fields

Field	Description
account_slug `String!`	The account's slug.
app_id `Int!`	The app's unique identifier.

Delete marketplace app discount input

The DeleteMarketplaceAppDiscountInput! type is an argument on the delete_marketplace_app_discounts mutation that specifies what discount to delete.

Fields

Field	Description
account_slug `String!`	The account's slug.
app_id `Int!`	The app's unique identifier.

Delete marketplace app discount result

The DeleteMarketplaceAppDiscount type reutrns metadata about the deleted discount.

Fields

Field	Description
deleted_discount `DeleteMarketplaceAppDiscount!`	The deleted discount's metadata.

Grant marketplace app discount

The GrantMarketplaceAppDiscount! type returns metadata for recently granted marketplace app discounts.

🚧
Only available in API versions 2024-10 and later

Fields

Field	Description	Enum values
account_slug `String!`	The account's slug.
app_id `ID!`	The app's unique identifier.
app_plan_ids `[String!]!`	The app plan ID.
days_valid `Int!`	The number of days the discount will be valid.
discount `Int!`	The discount's percentage.
is_recurring `Boolean!`	Returns `true` if the discount is recurring.
period `DiscountPeriod`	The discount's period. If it returns `null`, the discount applies to both yearly and monthly plans.	`MONTHLY` `YEARLY`

Grant marketplace app discount input

The GrantMarketplaceAppDiscountInput! type is an argument on the grant_marketplace_app_discounts mutation that specifies what discount to grant.

Fields

Field	Description	Enum values
account_slug `String!`	The account's slug.
app_id `ID!`	The app's unique identifier.
app_plan_ids `[String!]!`	The app plan ID.
days_valid `Int!`	The number of days the discount will be valid.
discount `Int!`	The discount's percentage.
is_recurring `Boolean!`	Returns `true` if the discount is recurring.
period `DiscountPeriod`	The discount's period. If it returns `null`, the discount applies to both yearly and monthly plans.	`MONTHLY` `YEARLY`

Grant marketplace app discount result

The GrantMarketplaceAppDiscountResult! type returns metadata about the granted discount.

Fields

Field	Description
granted_discount `GrantMarketplaceAppDiscount!`	The granted discount's metadata.

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.

Fields

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.

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.

Fields

Field	Description	Supported arguments	Enum values
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 `ItemsQueryOperator`	The 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.

Fields

Field	Description	Enum values
column_id `ID!`	The unique identifier of the column to filter by.
compare_attribute `String`	The comparison attribute. You can find the supported attributes for each column type in the column types reference. Please note that 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 `ItemsQueryRuleOperator`	The 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.

Fields

Field	Description	Enum 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 `ItemsOrderByDirection`	The direction to sort items in. The default is asc.	asc, desc

Linked items

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

Arguments

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.

Marketplace app discounts

The MarketplaceAppDiscounts type is used to return information about a marketplace app discount.

🚧
Only available in API versions 2024-10 and later

Fields

Field	Description	Enum values
account_slug `String!`	The account's slug.
app_id `ID!`	The app's unique identifier.
app_plan_ids `[String!]!`	The app plan ID.
created_at `String!`	The discount's creation date.
discount `Int!`	The discount's percentage.
is_recurring `Boolean!`	Returns `true` if the discount is recurring.
period `DiscountPeriod`	The discount's period. If it returns `null`, the discount applies to both yearly and monthly plans.	`MONTHLY` `YEARLY`
valid_until `String!`	The date the discount is valid until.

Marketplace app discounts input

The MarketplaceAppDiscountsInput! type contains fields to limit the items returned on marketplace_app_discounts queries.

Fields

Field	Description
app_id `ID!`	The app's unique identifier.
limit `Int`	The number of items to return. The default is 25.
page `Int`	The page number to get. Starts at 1.

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

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

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.

Fields

Field	Description	Enum values
id `ID!`	The unique identifier of the person or team.
kind `Kind`	The type of entity.	`person` `team`

Status label style

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

Fields

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

Time tracking history item

The TimeTrackingHistoryItem type is used as a field on the TimeTrackingValue implementation and 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 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.

Field	Description
description `String`	The updated workspace description.
kind `WorkspaceKind`	The kind of workspace to update: open or closed.
name `String`	The updated workspace name.

Account product

Fields

App install account

Fields

App install permissions

👍Pro tip

Fields

App install user

Fields

App version

Fields

Batch extend trial period

Arguments

Fields

Extend trial period

Fields

Change team memberships result

Fields

Column mapping input

Fields

Column type

Enum values

Create doc input

Fields

Create doc board input

Fields

Create doc workspace input

Fields

Delete marketplace app discount

🚧Only available in API versions 2024-10 and later

Fields

Delete marketplace app discount input

Fields

Delete marketplace app discount result

Fields

Grant marketplace app discount

🚧Only available in API versions 2024-10 and later

Fields

Grant marketplace app discount input

Fields

Grant marketplace app discount result

Fields

Items page by column values query

Fields

Items query

Fields

[ItemsQueryRule!]

Fields

[ItemsQueryOrderBy!]

Fields

Linked items

Arguments

Marketplace app discounts

🚧Only available in API versions 2024-10 and later

Fields

Marketplace app discounts input

Fields

Mirrored item

Fields

Number value unit direction

Enum values

People entity

Fields

Status label style

Fields

Position relative

Time tracking history item

Update workspace attributes input

👍
Pro tip

🚧
Only available in API versions `2024-10` and later

🚧
Only available in API versions `2024-10` and later

`[ItemsQueryRule!]`

`[ItemsQueryOrderBy!]`

🚧
Only available in API versions `2024-10` and later