Skip to main content
Version: 2.1.0

FavoriteLists API

Introduction

The Favorite Lists Service is a microservice responsible for managing user-specific and company-wide favorite lists. It provides a hybrid API with both REST and GraphQL endpoints to create, read, update, delete, and search for favorite lists. These lists can be associated with companies, contacts, or customers, and can contain products or product clusters.

Key features include:

  • Multi-tenancy: Data is partitioned by tenant.
  • Flexible Associations: Lists can be linked to companies, contacts, or customers.
  • Dynamic Content: Lists can contain products or clusters of products.
  • Default Lists: Support for default favorite lists.
  • Hybrid API: Provides both RESTful and GraphQL interfaces for flexible integration.

Favorite List Data Structure

This section outlines the fields and properties of a favorite list.

FieldTypeDescriptionExample
idstringA unique identifier for the favorite list.67d2a7d52dfe2a405d3bd5b9
namestringThe name of the favorite list.Monthly Office Supplies
companyIdnumber (optional)The unique ID of the company associated with the list.1482
contactIdnumber (optional)The unique ID of the contact associated with the list.15083
customerIdnumber (optional)The unique ID of the customer associated with the list.14383
productIdsnumber[] (optional)A list of product IDs in the favorite list.[71516, 114258, 69237]
clusterIdsnumber[] (optional)A list of cluster IDs in the favorite list.[2920, 764, 1437]
isDefaultbooleanIndicates if this is a default favorite list.true
slugstringA URL-friendly slug for the favorite list.monthly-office-supplies
createdAtDate (optional)The date and time when the favorite list was created.2025-07-03T13:38:00.000Z
updatedAtDate (optional)The date and time when the favorite list was last updated.2025-07-03T13:38:00.000Z

Authentication

OAuth2 Authorization

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Scopes: