Skip to main content

FavoriteListsSearchInput

No description

input FavoriteListsSearchInput {
  name: String
  isDefault: Boolean
  page: Int
  offset: Int
  companyId: Int
  companySource: SourceInput
  contactId: Int
  contactSource: SourceInput
  customerId: Int
  customerSource: SourceInput
  productIds: [Int!]
  productSources: [SourceInput!]
  clusterIds: [Int!]
  clusterSources: [SourceInput!]
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
}

Fields​

FavoriteListsSearchInput.name ● String scalar​

Text search filter for favorite list names.

Performs a partial, case-sensitive match on the favorite list name field. Use this to find lists with names containing the specified text. Maximum length is 64 characters.

FavoriteListsSearchInput.isDefault ● Boolean scalar​

Filter by default list status.

When true, returns only favorite lists marked as default. When false, returns only non-default lists. When omitted, returns both default and non-default lists.

FavoriteListsSearchInput.page ● Int scalar​

Page number for pagination.

Determines which page of results to return. Must be a positive integer starting from 1. Default value is 1 if not specified.

FavoriteListsSearchInput.offset ● Int scalar​

Number of items per page for pagination.

Controls how many favorite lists are returned in each page. Must be a positive integer. Default value is 12 if not specified.

FavoriteListsSearchInput.companyId ● Int scalar​

Filter by company ownership using internal company ID.

Returns favorite lists that belong to the specified company. Cannot be used with other ownership filters (contact/customer) in the same request. Must reference an existing company in the system.

FavoriteListsSearchInput.companySource ● SourceInput input​

Filter by company ownership using external source identifier.

Use this when referencing a company from an external system that is not directly managed in the internal system. Cannot be used with other ownership filters or companyId in the same request. Must contain a valid name and external ID combination.

FavoriteListsSearchInput.contactId ● Int scalar​

Filter by contact ownership using internal contact ID.

Returns favorite lists that belong to the specified contact. Cannot be used with other ownership filters (company/customer) in the same request. Must reference an existing contact in the system.

FavoriteListsSearchInput.contactSource ● SourceInput input​

Filter by contact ownership using external source identifier.

Use this when referencing a contact from an external system that is not directly managed in the internal system. Cannot be used with other ownership filters or contactId in the same request. Must contain a valid name and external ID combination.

FavoriteListsSearchInput.customerId ● Int scalar​

Filter by customer ownership using internal customer ID.

Returns favorite lists that belong to the specified customer. Cannot be used with other ownership filters (company/contact) in the same request. Must reference an existing customer in the system.

FavoriteListsSearchInput.customerSource ● SourceInput input​

Filter by customer ownership using external source identifier.

Use this when referencing a customer from an external system that is not directly managed in the internal system. Cannot be used with other ownership filters or customerId in the same request. Must contain a valid name and external ID combination.

FavoriteListsSearchInput.productIds ● [Int!] list scalar​

Filter by products contained in the favorite lists.

Returns favorite lists that contain ANY of the specified product IDs. Use this to find lists that include specific products. Each ID must reference an existing product in the system.

FavoriteListsSearchInput.productSources ● [SourceInput!] list input​

Filter by products using external source identifiers.

Returns favorite lists that contain ANY of the specified product sources. Use this when referencing products from external systems that are not directly managed in the internal catalog. Each source must contain a valid name and external ID combination.

FavoriteListsSearchInput.clusterIds ● [Int!] list scalar​

Filter by clusters contained in the favorite lists.

Returns favorite lists that contain ANY of the specified cluster IDs. Use this to find lists that include specific product clusters. Each ID must reference an existing cluster in the system.

FavoriteListsSearchInput.clusterSources ● [SourceInput!] list input​

Filter by clusters using external source identifiers.

Returns favorite lists that contain ANY of the specified cluster sources. Use this when referencing clusters from external systems that are not directly managed in the internal catalog. Each source must contain a valid name and external ID combination.

FavoriteListsSearchInput.createdAt ● DateSearchInput input​

Filter by creation date range.

Use this to find favorite lists created within a specific time period. Supports various date range operations like greaterThan, lessThan for flexible date filtering. Dates should be provided in ISO 8601 format.

FavoriteListsSearchInput.lastModifiedAt ● DateSearchInput input​

Filter by last modification date range.

Use this to find favorite lists that were updated within a specific time period. Supports various date range operations like greaterThan, lessThan for flexible date filtering. Dates should be provided in ISO 8601 format.

Member Of​

favoriteLists query