Favorites

Learn how to read, create, update, and delete favorites using the platform API

On the monday.com platform, you can create favorites for your preferred and most frequently used boards, dashboards, and docs. The favorite objects then appear in a separate Favorites section of the left-side menu for quick, easy access.

Queries

You can retrieve monday.com favorites data via the API through the favorites query.

  • Returns metadata for a list of favorites
  • Can only be queried at the root; cannot be nested within another query
🚧 The `favorites` query is only available in API versions 2025-10 and later
query {
  favorites {
    accountId
    createdAt
    folderId
    hierarchyListData {
      id
      type
    }
    id
    object {
      id
      type
    }
    position
    updatedAt
  }
}
{
  "data": {
    "favorites": [
      {
        "accountId": 9876543210,
        "createdAt": null,
        "folderId": null,
        "hierarchyListData": {
          "id": "123456",
          "type": "PersonalList"
        },
        "id": "98765",
        "object": {
          "id": "11223344",
          "type": "Overview"
        },
        "position": 65500,
        "updatedAt": null
      },
      {
        "accountId": 9876543210,
        "createdAt": null,
        "folderId": null,
        "hierarchyListData": {
          "id": "123456",
          "type": "PersonalList"
        },
        "id": "12345",
        "object": {
          "id": "44332211",
          "type": "Board"
        },
        "position": 65400,
        "updatedAt": null
      }
    ]
  },
  "extensions": {
    "request_id": "YOUR_REQUEST_ID"
  }
}

Fields

You can use the following field(s) to specify what information your favorites query will return. Some fields support their own subfields.

FieldDescriptionSupported Subfields
accountId IntThe ID of the account the favorite object belongs to.
createdAt DateThe timestamp when the favorite object was created.
folderId IDThe unique identifier of the folder the favorite object is in (if applicable).
hierarchyListData ListIDThe type and unique identifier of the list. id ID
type ListType
id IDThe favorite object's unique identifier.
object HierarchyObjectIdThe type and unique identifier of the favorite object.id ID
type ObjectType
position FloatThe favorite object's position within its list or folder.
updatedAt DateThe timestamp when the favorite object was last updated.

Mutations

🚧 The favorites mutations are only available in API versions 2025-10 and later

Create favorite

The create_favoritemutation creates a new favorite via the API. It returns the CreateFavoriteResultType type which allows you to specify what fields to query back when you run it.

mutation {
  create_favorite (
    input: {
      name: "Tasks"
      object: {
        id: 1234567890
        type: Board
      }
      newPosition: {
        prevObject: {
          id: 9876543210
          type: Overview
        }
      }
    }
  ) {
    favorites {
      position
      id
    }
  }
}
{
  "data": {
    "create_favorite": {
      "favorites": {
        "position": 12345,
        "id": "98765"
      }
    }
  },
  "extensions": {
    "request_id": "YOUR_REQUEST_ID"
  }
}

Arguments

ArgumentDescriptionInput Fields
input CreateFavoriteInput!The new favorite's name, position, identifier, and type.object HierarchyObjectIDInputType!
name String
newPosition ObjectDynamicPositionInput

Update favorite position

The update_favorite_positionmutation updates a favorite's position via the API. It returns the UpdateFavoriteResultType type which allows you to specify what fields to query back when you run it.

mutation {
  update_favorite_position (
    input: {
      object: {
        id: 1234567890
        type: Board
      }
      newPosition: {
        nextObject: {
          id: 9876543210
          type: Overview
        }
      }
    }
  ) {
    favorites {
      position
      id
      hierarchyListData {
        id
        type
      }
    }
  }
}

{
  "data": {
    "update_favorite_position": {
      "favorites": {
        "position": 54321,
        "id": "98765",
        "hierarchyListData": {
          "id": "123456",
          "type": "PersonalList"
        }
      }
    }
  },
  "extensions": {
    "request_id": "YOUR_REQUEST_ID"
  }
}

Arguments

ArgumentDescriptionInput Fields
input UpdateObjectHierarchyPositionInput!The updated favorite's position and type. object HierarchyObjectIDInputType!
newFolderId ID
newPosition ObjectDynamicPositionInput

Delete favorite

The delete_favoritemutation deletes a favorite via the API. It returns the DeleteFavoriteInputResultType type which allows you to specify what fields to query back when you run it.

mutation {
  delete_favorite (
    input: {
      object: {
        id: 1234567890
        type: Board
      }
    }
  ) {
    success
  }
}
{
  "data": {
    "delete_favorite": {
      "success": true
    }
  },
  "extensions": {
    "request_id": "YOUR_REQUEST_ID"
  }
}

Arguments

ArgumentDescriptionInput Fields
input DeleteFavoriteInput!The deleted favorite's input.object HierarchyObjectIDInputType!