Skip to content

List the signed-in member's wishlist

GET
/wishlists
curl --request GET \
--url 'https://acme.mykreezalid.com/front_api/v1/wishlists?type=listing&page=1&limit=20' \
--header 'Authorization: Bearer <token>'

Returns the listings (by default) or the vendors (type=vendor) saved in the signed-in member’s wishlist, one page at a time. Listings that are no longer online and vendors that are no longer active are left out.

type
string
default: listing
Allowed values: listing vendor

Kind of entries to list.

page
integer
default: 1 >= 1

Page to return. A page beyond the last one answers 404.

limit
integer
default: 20 >= 1 <= 100

Number of entries per page.

One page of the wishlist.

Media typeapplication/json
object
wishlists
Array<object>

An entry of the signed-in member’s wishlist. A listing entry carries listing_id and listing; a vendor entry carries vendor_id and user.

object
listing_id

Listing saved in the wishlist (listing entries only).

integer
listing

The saved listing (listing entries only). Only listings that are online appear in the wishlist. Besides the fields below, the object carries display fields computed for the marketplace’s own pages.

object
id
integer
title
string
slug
string
nullable
url_key
string
nullable
url

Path of the listing page on the marketplace.

string
nullable
description
string
nullable
price

Price, as a decimal number in a string.

string
nullable
original_price

Price before discount, as a decimal number in a string.

string
nullable
currency
string
nullable
quantity
number
nullable
status
string
admin_status
string
location
string
nullable
city
string
nullable
state
string
nullable
country
string
nullable
category_id
integer
nullable
user_id

Identifier of the vendor of the listing.

integer
expiration_date
string format: date-time
nullable
valid_until
string format: date-time
nullable
image_cover

First image of the listing.

object
listing_id
integer
path
string
category
object
title
string
slug
string
price_unit

Unit the price applies to, such as a night or a day.

object
id
integer
slug
string
title
string
user

The vendor of the listing.

object
id
integer
public_name
string
avatar
string
nullable
key
additional properties
any
key
additional properties
any
vendor_id

Vendor saved in the wishlist (vendor entries only).

integer
user

The saved vendor (vendor entries only). Only active vendors appear in the wishlist. Besides the fields below, the object carries display fields computed for the marketplace’s own pages.

object
id
integer
public_name
string
avatar
string
nullable
public_vars

A member of the marketplace (a buyer, a vendor, or both). Returned for the signed-in member by GET /auth/me and POST /account/create, and as the customer or the vendor of a review or an order.

object
object

A member of the marketplace, as the Front API returns it.

string
id

Unique identifier of the member.

integer
external_id

Identifier of the member in your own system, if you set one.

string
nullable
account_type

Legal form of the member.

string
nullable
Allowed values: individual company soletrader non_profit
first_name
string
nullable
last_name
string
nullable
username
string
nullable
public_name

Name shown to other members, built from the member’s details according to the marketplace’s display settings.

string
business_name
string
nullable
email
string format: email
avatar

URL of the member’s profile picture.

string format: uri
nullable
birthday
string format: date
nullable
nationality

Country code.

string
nullable
lang

Preferred language of the member.

string
nullable
locale

Same value as lang.

string
nullable
timezone
string
nullable
phone_country_code
string
nullable
phone_number
string
nullable
address_line1
string
nullable
address_line2
string
nullable
address_city
string
nullable
address_zipcode
string
nullable
address_state
string
nullable
address_country

Country code.

string
nullable
company

Company details. Absent when account_type is individual.

object
object
string
name

Same value as the member’s business_name.

string
nullable
number

Company registration number.

string
nullable
website_url
string
nullable
address_line1
string
nullable
address_line2
string
nullable
address_city
string
nullable
address_zipcode
string
nullable
address_state
string
nullable
address_country
string
nullable
group

The member group (type of account) the member belongs to.

object
object
string
id
integer
nullable
name

Name of the group.

string
nullable
alias

Handle of the group.

string
nullable
group_id

Use group.id.

integer
nullable
group_name

Use group.name.

string
nullable
group_alias

Use group.alias.

string
nullable
can_post_listing

Whether the member’s group may publish listings.

boolean
is_onboarding

Whether the member’s group is an onboarding group.

boolean
status

Whether the account is active.

string
Allowed values: enabled disabled unknown
identity_status

Progress of the member’s identity verification. Read-only: the member cannot change it.

string
nullable
Allowed values: not_completed completed
attributes

Values of the custom member fields defined by the marketplace, keyed by field alias. A value is a string, or a list for multiple-choice fields.

object
key
additional properties
any
metafields

Custom data attached to the member, grouped by namespace then keyed by title: {"namespace": {"title": "value"}}. null when the member has none.

object
key
additional properties
object
key
additional properties
any
listing_count

Number of the member’s listings online.

integer
nullable
listing_count_any_status

Number of the member’s listings, whatever their status.

integer
average_rating

Average rating received in reviews.

number
nullable
review_count

Number of reviews received.

integer
nullable
profile_url

Public profile page of the member on the marketplace.

string format: uri
created_at

Registration date, as YYYY-MM-DD HH:MM:SS.

string
nullable
key
additional properties
any
pagination

Paging information, added next to the results of a paginated list. Request another page with the page query parameter and change the page size with limit (at most 100).

object
totalResultsCount

Number of results across all pages.

integer
currentPage

Number of the page returned, starting at 1.

integer
nextPage

Whether a next page exists.

boolean
prevPage

Whether a previous page exists.

boolean
resultOnPageCount

Number of results on this page.

integer
pageCount

Number of pages.

integer

Example

{
"wishlists": [
{
"listing_id": 4242,
"listing": {
"id": 4242,
"title": "City bike, 7 speeds",
"price": "129.90",
"currency": "EUR",
"status": "published",
"admin_status": "approved"
},
"vendor_id": 4242,
"user": {
"id": 4242,
"public_name": "Jane D.",
"public_vars": {
"object": "User",
"id": 4242,
"account_type": "individual",
"first_name": "Jane",
"last_name": "Doe",
"public_name": "Jane D.",
"email": "jane@example.com",
"birthday": "1990-04-12",
"nationality": "FR",
"lang": "fr",
"locale": "fr",
"timezone": "Europe/Paris",
"phone_country_code": "33",
"phone_number": "612345678",
"address_line1": "12 rue de la Paix",
"address_city": "Paris",
"address_zipcode": "75002",
"address_country": "FR",
"company": {
"object": "Company"
},
"group": {
"object": "Group",
"id": 12,
"name": "Vendors",
"alias": "vendors"
},
"status": "enabled",
"identity_status": "not_completed",
"attributes": {
"profession": "Photographer"
},
"average_rating": 4.5,
"profile_url": "https://acme.mykreezalid.com/s/a1b2c3d/jane-d",
"created_at": "2026-10-01 09:30:00"
}
}
}
],
"pagination": {
"totalResultsCount": 137,
"currentPage": 1,
"resultOnPageCount": 25,
"pageCount": 6
}
}

No valid access token was sent.

Media typeapplication/json

Error body returned by the Front API when it refuses a request.

object
code

HTTP status code, repeated in the body.

integer
status
string
message

Human-readable reason.

string

Example

{
"code": 403,
"status": "error",
"message": "Token not found in request"
}

The requested page is beyond the last one.