Account product

The AccountProduct 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, project_management, software, whiteboard

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. Please note that this mutation is only available in API version 2023-10 for now.

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.

Items by column values query

The ItemsByColumnValuesQuery 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. Please note that this argument is only available in API version 2023-10 for now.

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. Please note that this argument is only available in API version 2023-10 for now.

Fields

Field	Description	Supported arguments	Enum values
ids `[ID!]`	The specific item IDs to return.
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. Please note that this field is only available in API version 2023-10 for now.

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.

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`

Status label style

The StatusLabelStyle type is used as a field on the StatusValue implementation and contains a set of fields that retyrn 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.