Skip to main content
GET
List favorites

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

user_company_id
string
required

Query Parameters

by_type
string

Only favorites of this item type, for example product, medium, page, or enrollment_pack.

country_id
integer

Country used for product pricing. Defaults to your country, then the company's default country.

Response

Success

id
integer

Favorite ID.

user_company_id
integer | null

ID of the membership that owns the favorite.

order
integer | null

Position in the member's favorites list.

created_at
string<date-time> | null
favoriteable_type
string

Type of the favorited item, for example Product, Medium, Page, or EnrollmentPack.

favoriteable
object | null

The favorited item, rendered in the same shape the matching resource endpoint returns.