Skip to main content

List FavoriteList

GET 
/v1/favoritelists

List FavoriteList

Request​

Query Parameters

    page any

    Pagination page number

    Example: 1
    offset any

    Pagination offset number

    Example: 12
    name string

    Favorite List name

    Example: MyFavoriteList
    isDefault boolean

    Favorite List is default

    Example: true
    companyId integer

    Favorite List company ID

    Example: 1234
    contactId integer

    Favorite List contact ID

    Example: 1234
    customerId integer

    Favorite List customer ID

    Example: 1234
    productIds integer[]

    List of product ids

    Example: [1234, 5678]
    clusterIds integer[]

    List of cluster ids

    Example: [1234, 5678]

Responses​

Paginated list of FavoriteList

Schema

    items

    object[]

    required

    List of items of type FavoriteListDto

  • Array [

    • name stringrequired

    Possible values: <= 64 characters

    Favorite List name

    companyId int

    Favorite List company ID

    contactId int

    Favorite List contact ID

    customerId int

    Favorite List customer ID

    productIds number[]

    Favorite List product IDs list

    clusterIds number[]

    Favorite List cluster IDs list

    isDefault booleanrequired

    Default Favorite List

    slug stringrequired

    Favorite List slug

    createdAt date-time

    Favorite List date created

    updatedAt date-time

    Favorite List date modified

    id stringrequired

    Favorite List identifier

  • ]

    • itemsFound integerrequired

    Total number of items found

    offset integernullablerequired

    Possible values: >= 1

    Default value: 12

    The amount of items to show per page

    page integernullablerequired

    Possible values: >= 1

    Default value: 1

    The current page

    pages integernullablerequired

    Possible values: >= 1

    Total amount of pages

    start integernullablerequired

    Possible values: >= 1

    Start position of the current page

    end integernullablerequired

    Possible values: >= 1

    End position of the current page

Loading...