favoriteLists
Search and retrieve favorite lists with comprehensive filtering and pagination.
Provides flexible search capabilities across favorite list data including names, owners, item types, and creation dates. Results are paginated and can be filtered by customer, contact, or other criteria.
Supports advanced filtering by:
- Name-based text search (case-sensitive partial matching)
- Owner-based filtering (company, contact, or customer - mutually exclusive)
- Content-based filtering (products and clusters using IDs or external sources)
- Date range filtering (creation and modification dates)
- Default list status filtering
Pagination is controlled through page and offset parameters with configurable limits.
Possible errors:
- FAVORITE_LISTS_SEARCH_ERROR: Failed to search favorite lists due to system error
- FAVORITE_LISTS_INVALID_INPUT_ERROR: Invalid search criteria or validation failure
- FAVORITE_LISTS_UNKNOWN_ERROR: Unexpected system error during search operation
AUTH: Role=[system] OR ('user is authenticated')
favoriteLists(
input: FavoriteListsSearchInput
): FavoriteListsResponse!
Arguments
favoriteLists.input ● FavoriteListsSearchInput input
Search criteria for filtering favorite lists.
Contains optional filters for name, ownership, content, dates, and pagination settings. If not provided, returns all accessible favorite lists with default pagination (page 1, offset 12).
Validation constraints:
- Only one ownership type allowed (company OR contact OR customer)
- Page must be positive integer (minimum 1)
- Offset must be positive integer (minimum 1)
- Name filter supports partial matching with maximum length of 64 characters
- Date filters support standard ISO 8601 date range operations