Learn about the other types used reading filtered items data using the platform API
The monday.com items_page API enables you to read items on a board using expressive filters.
Each of the object types described below represents a specific aspect of a filter. They can be provided as arguments to define a filtered items query.
ItemsQuery
An object containing a set of parameters to filter, sort, and control the scope of the query.
| Field | Description | Enum Values | Supported Fields |
|---|---|---|---|
groups [ItemsQueryGroup!] | The group rules and attributes to filter your queries. | groups [ItemsQueryGroup!]operator ItemsQueryOperatorrules [ItemsQueryRule!] | |
ids [ID!] | The specific item IDs to return. The maximum is 100. | ||
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 | |
rules [ItemsQueryRule!] | The rules to filter your queries. | column_id ID!compare_attribute Stringcompare_value CompareValue!operator ItemsQueryRuleOperator |
ItemsQueryGroup
An object containing the group rules.
| Field | Description | Enum Values | Supported Fields |
|---|---|---|---|
groups [ItemsQueryGroup!] | The group rules and attributes to filter your queries. | groups [ItemsQueryGroup!]operator ItemsQueryOperatorrules [ItemsQueryRule!] | |
operator ItemsQueryOperator | The conditions between query rules. The default is and. | andor | |
rules [ItemsQueryRule!] | The rules to filter your queries. | column_id ID!compare_attribute Stringcompare_value CompareValue!operator ItemsQueryRuleOperator |
ItemsQueryOrderBy
An object containing the attributes to sort results by.
| 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. | ascdesc |
ItemsQueryRule
An object containing the rules to filter your queries.
| 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. 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_ofnot_any_ofis_emptyis_not_emptygreater_thangreater_than_or_equalslower_thanlower_than_or_equalbetweennot_contains_textcontains_textcontains_termsstarts_withends_withwithin_the_nextwithin_the_last |
