Learn about the other types used when reading, creating, updating, and deleting favorites via the API
The monday.com favorites API lets you query a user's favorites.
Each of the object types described below represents a specific aspect of a favorite. They can be queried as subfields on the favorites query or provide favorite metadata in mutations.
CreateFavoriteInput
An object containing the input of the new favorite to create.
| Field | Description | Input Fields |
|---|---|---|
name String | The name of the object to mark as a favorite. | |
newPosition ObjectDynamicPositionInput | The new position of the favorite object. | nextObject HierarchyObjectIDInputTypeprevObject HierarchyObjectIDInputType |
object HierarchyObjectIDInputType! | The type of object to mark as a favorite. | id ID!type ObjectType! |
CreateFavoriteResultType
An object containing the result of creating a new favorite via the API.
| Field | Description | Supported Subfields |
|---|---|---|
favorites HierarchyObjectItem | The new favorite object's metadata. | accountId IntcreatedAt DatefolderId IDhierarchyListData ListIDid IDobject HierarchyObjectIDposition FloatupdatedAt Date |
DeleteFavoriteInput
An object containing the input of the favorite to delete.
| Field | Description | Input Fields |
|---|---|---|
object HierarchyObjectIDInputType! | The object to remove from the favorites. | id ID!type ObjectType! |
DeleteFavoriteInputResultType
An object containing the result of deleting a favorite object via the API.
| Field | Description |
|---|---|
success Boolean | Whether the favorite was successfully deleted. |
HierarchyObjectId
An object containing metadata about the favorited object.
| Field | Description | Enum Values |
|---|---|---|
id ID | The object's unique identifier. | |
type ObjectType | The object's type. | BoardFolderOverview |
HierarchyObjectIDInputType
Metadata about the favorite object.
| Field | Description | Enum Values |
|---|---|---|
id ID! | The object's unique identifier. | |
type ObjectType! | The object's type. | BoardFolderOverview (dashboard) |
ListID
An object containing metadata about the favorited list.
| Field | Description | Enum Values |
|---|---|---|
id ID | The list's unique identifier. | |
type ListType | The list's type. | CustomizedListPersonalListWorkspace |
UpdateObjectHierarchyPositionInput
An object containing the input of the favorite to update.
| Field | Description | Input Fields |
|---|---|---|
newFolder ID | The unique identifier of the folder to move the favorite object into. | |
newPosition ObjectDynamicPositionInput | The new position of the favorite object in the favorites list. | nextObject HierarchyObjectIDInputTypeprevObject HierarchyObjectIDInputType |
object HierarchyObjectIDInputType! | The favorite object to update. |
UpdateFavoriteResultType
An object containing the result of updating a favorite object's position via the API.
| Field | Description | Supported Subfields |
|---|---|---|
favorites HierarchyObjectItem | The updated favorite object's metadata. | accountId IntcreatedAt DatefolderId IDhierarchyListData ListIDid IDobject HierarchyObjectIDposition FloatupdatedAt Date |
