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.

Fields

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

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

Column type

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

Enum values

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

Create doc board input

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

Fields

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

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

Fields

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

Fields

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

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

[ItemsQueryRule!]

The rules to filter your queries.

Fields

[ItemsQueryOrderBy!]

The attributes to sort results by.

Fields

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

Linked items

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

Arguments

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

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

People entity

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

Fields

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.

Fields

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.

Fields

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.

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.

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.

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.

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.