Items By Column Values
Required scope: boards:read
monday.com items are another core object in the platform. Items are the objects that hold the actual data within the board, to better illustrate this, you can think of a board as a table and an item as a single row in that table.
You can learn more about this object type here.
Querying items_by_column_values() searches for items based on predefined column values and returns data about these specific items.
You can only use items by column values at the root of your query. They cannot be nested within another query.
query {
items_by_column_values (board_id: 1234567, column_id: "date", column_value: "2019-02-06") {
id
name
}
}
let query = "query { items_by_column_values (board_id: 1234567, column_id: \"date\", column_value: \"2019-02-06\") { id name } }";
fetch ("https://api.monday.com/v2", {
method: 'post',
headers: {
'Content-Type': 'application/json',
'Authorization' : 'YOUR_API_KEY_HERE'
},
body: JSON.stringify({
query : query
})
})
.then(res => res.json())
.then(res => console.log(JSON.stringify(res, null, 2)));
curl --location --request POST 'https://api.monday.com/v2' \
--header 'Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ0aWQiOjk3NjE2MTE3LCJ1aWQiOjk2MDM0MTcsImlhZCI6IjIwMjEtMDEtMjhUMTU6MjM6MzAuMDAwWiIsInBlciI6Im1lOndyaXRlIiwiYWN0aWQiOjQzNjUxODUsInJnbiI6InVzZTEifQ.7VPotMxEZfubObCtrVVPyqUIb70Cz5lGmD50CXpkcTI' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfduid=d4512e647bd3dd90706f5673d6041f7c51618840981' \
--data-raw '{"query": "query { items_by_column_values (board_id: 1234567, column_id: "date", column_value: "2019-02-06") { id name } }"}'
Arguments
The following items_by_column_values() arguments can reduce the number of item returned.
Unlike other queries, when querying items by their column values, there are some arguments that must be included, and some arguments that are optional.
Argument | Description |
|---|---|
limit | The number of items returned. |
page | The page number to get, starting at 1. |
board_id | The board's unique identifier. |
column_id | The column's unique identifier. |
column_value | The column value to search items by. You can use text values for the search. |
column_type | The column type to search by. For example, a Status column's type is "color". |
state | The state of the item, which includes the following options:
|
Fields
The following fields will determine what information is returned from your items_by_column_values() queries. Some fields will have their own arguments.
The fields available for items_by_column_values() are exactly the same as the fields available in Items.
Field | Field Definition | Arguments |
|---|---|---|
assets | The item's assets/files. | column_ids |
board | The board that contains this item. | |
column_values | The item's column values. | ids |
created_at | The item's creation date. | |
creator | The item's creator. | |
creator_id | The unique identifier of the user who created the item. | |
group | The group that contains this item. | |
id | The item's unique identifier. | |
name | The item's name reflected in the first column of any board. | |
parent_item | The relevant parent item. This is for querying subitems. If used for a parent item, it will return | assets |
state | The item's state, which includes the following options:
| |
subscribers | The user IDs of the users who are subscribed to this item. | |
updated_at | The date when the item was last updated. | limit |
updates | The item's updates. | limit |
Supported Columns
The following columns support the items_by_column_values() queries. In addition, you can find provided notes about the column types.
Supported Columns | Notes |
|---|---|
Text | |
Long Text | |
Status | Search for values based on Label (text within the cell), and not on index. (i.e., |
Numbers | Search for the number as a string, and not as an integer. For example, if you’d like to find all items with a 15 value, search for |
Date | Search for |
Hour | |
Phone | |
Country | |
World Clock | Search for the text value of the column. For example, |
Limited Support Columns
The following columns provide limited support for the items_by_column_values() queries.
Column type | Notes |
|---|---|
People column | Will only return results for items where a single user is assigned. Doesn’t support arrays of users, will only return results based on actual user name and not User ID; |
Dropdown column | Will only return a single value that you search. If you have an item with Dropdown labels such as |
Timeline column | Your query has to match the values shown in the
|
File column | Will return a single file as a result, but not multiple files. You will need to use the full item name, together with the extension. If your filename is |
Week column | The text version of the week should be used. For example, if your Week column is set to a week from February-22, 2021 to February 28, 2022, the query should look like this:
Then, you’ll be able to get the item; |
Dependency column | Supports individual items only; |
Link column | Will return results based on the |
Not Supported Columns
The following columns are not supported by the items_by_column_values() queries.
- Tags: not supported
- Connect Boards: not supported
- Mirrored columns: not supported
- Checkbox column: not supported
- Location column: not supported
- Rating: not supported
- Color picker: not supported
- AutoNumber - not supported
- Formula - not supported
- Item ID - not supported
- Last Updated - not supported
- Creation Log - not supported
- Vote - not supported
- Time Tracking - not supported
Note
When creating an item or adding a value to a column, the new value for the column might take up to 30 seconds to be available for retrieving using items_by_column_values().
The maximum amount of items that can be retrieved using items_by_column_values() is 10,000.
Do you have questions?
Join our developer community! You can share your questions and learn from fellow users and monday.com product experts.
Don’t forget to search before opening a new topic!
Updated 7 days ago