Learn how to read the item ID column on monday boards using the platform API
The item ID column displays the unique identifier assigned to each item.
Via the API, the item ID column only supports read operations. You can also read an item's ID by querying id on any field that returns an items type.
Column Type | Implementation Type | Supported Operations |
|---|---|---|
|
|
|
Queries
Item ID columns can be queried through the column_values field on items queries using an inline fragment on ItemIdValue.
query {
items(ids: [1234567890, 9876543210]) {
column_values {
... on ItemIdValue {
value
text
}
}
}
}import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });
const query = `
query($itemIds: [ID!], $columnType: [ColumnType!]) {
items(ids: $itemIds) {
id
column_values(types: $columnType) {
column { title id }
... on ItemIdValue {
item_id
}
}
}
}
`;
const variables = {
itemIds: [9571351485, 9572374902],
columnType: "item_id"
};
const response = await mondayApiClient.request(query, variables);Fields
You can use the following fields to specify what information your ItemIdValue implementation will return.
| Field | Description |
|---|---|
column Column! | The column the value belongs to. |
id ID! | The column's unique identifier. |
item_id ID! | The item's unique identifier. |
text String | The column's value as text. |
type ColumnType! | The column's type. |
value JSON | The column's JSON-formatted raw value. |
