List your listings

GET

/listings

const url = 'https://acme.mykreezalid.com/front_api/v1/listings?page=1&limit=25&fields=id%2Ctitle%2Cprice';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://acme.mykreezalid.com/front_api/v1/listings?page=1&limit=25&fields=id%2Ctitle%2Cprice' \
  --header 'Authorization: Bearer <token>'

Returns the listings of the signed-in member, newest first, 25 per page.

Authorizations

bearerAuth

Parameters

Query Parameters

page

integer

default: 1 >= 1

Page to return, starting at 1.

limit

integer

default: 25 >= 1 <= 100

Number of listings per page (at most 100).

fields

string

Comma-separated list of listing fields to return, for example id,title,price. Each listing then only contains the requested fields that it has.

Example

id,title,price

Responses

200

Your listings.

application/json

object

listings

Array<object>

A listing (product, service or offer) of the marketplace.

object

object

string

Unique identifier of the listing.

integer

add_ons

Options a buyer can add to the listing. null when the listing has none.

Array<object>

nullable

object

object

string

integer

listing_id

integer

price

number

description

string

nullable

title

string

address

Address of the listing, also given as separate top-level fields.

object

location

string

nullable

city

string

nullable

state

string

nullable

country

string

nullable

admin_status

Moderation status set by the marketplace: waiting (awaiting approval), approved, rejected or blocked. A listing is visible to buyers only when it is approved and published.

string

Allowed values: waiting approved rejected blocked

attributes

Values of the listing attributes, keyed by attribute alias (see GET /listings/attributes).

object

key

additional properties

any

category

Category of the listing. Only object and id are always present.

object

object

string

integer

parent_id

integer

nullable

title

string

slug

string

url

string

city

string

nullable

country

string

nullable

cover

URL of the cover image: the first image of the listing (or the vendor’s avatar when the listing type is set up that way), or a default placeholder image.

string

currency

string

nullable

date_online

Date the listing went online, as YYYY-MM-DD HH:MM:SS.

string

nullable

description

Description of the listing, as plain text.

string

nullable

external_id

Your own reference for the listing.

string

nullable

formatted_price

Price ready for display, with currency and price unit. May contain HTML markup. When the price is zero, the free label of the listing type (or Free).

string

lat

number

nullable

lng

number

nullable

location

string

nullable

logistic_category

Logistic category of the listing, used to compute shipping rates.

object

object

string

integer

title

string

min_qty

Minimum quantity a buyer must order.

integer

nullable

medias

Images of the listing, in display order. null when the listing has none.

Array<object>

nullable

object

object

string

integer

alt

string

nullable

position

integer

media_type

string

src

string

media_videos

Videos of the listing. null when the listing has none.

Array<object>

nullable

object

object

string

integer

position

integer

media_type

string

src

string

embed

string

nullable

metafields

Custom data attached to the listing, grouped by namespace then by key.

object

key

additional properties

any

original_price

Price before discount.

number

nullable

price

Price of the listing. When the listing has variants, the lowest variant price.

number

nullable

price_unit

Title of the price unit (for example night), or null.

string

nullable

price_with_currency

Price with its currency, or the free label when the price is zero.

string

properties

Extra key/value properties of the listing (an empty array when there are none).

object

key

additional properties

any

status

Publication status chosen by the vendor.

string

Allowed values: draft published archived

quantity

Stock.

integer

nullable

quantity_selector

How the buyer picks the quantity.

string

nullable

requires_shipping

Whether the listing must be shipped.

boolean

nullable

sku

string

nullable

state

string

nullable

shipping_methods

Shipping methods selected for the listing.

Array<object>

nullable

object

integer

object

string

carrier_alias

string

nullable

is_hand_delivery

Whether the buyer collects the item in person.

boolean

price

number

sort_priority

integer

step_price

Price added for each extra item.

number

title

string

logistic_category_id

integer

nullable

slug

string

nullable

title

string

url

Public URL of the listing page.

string

variants

Variants of the listing. null when it has none.

Array<object>

nullable

A variant of a listing (for example one size or one colour).

object

object

string

integer

external_id

Your own reference for the variant.

string

nullable

listing_id

integer

price

number

nullable

price_unit

Price unit of the variant, or null.

object

key

additional properties

any

quantity

Stock of the variant.

integer

nullable

sort_priority

integer

nullable

sku

string

nullable

title

string

nullable

weight

number

nullable

cover_id

Identifier of the listing image shown for this variant.

integer

nullable

visibility

Where the listing is shown: both (catalog and search), catalog, search, or none.

string

Allowed values: both catalog search none

weight

number

nullable

weight_unit

string

nullable

_geoloc

Coordinates of the listing.

object

lat

number

nullable

lng

number

nullable

owner

Public profile of the vendor. Present only when the vendor is known.

object

object

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

string

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

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

user

Same value as owner, kept for compatibility. null when the vendor is unknown.

object

object

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

string

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

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

supplier

Same value as owner, kept for compatibility. null when the vendor is unknown.

object

object

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

string

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

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

store

Shop of the vendor that holds the item. Present only when your marketplace lets vendors manage several shops and the listing is assigned to one.

object

key

additional properties

any

valid_until

End of validity of the listing, as YYYY-MM-DD HH:MM:SS. Present only when set.

string

nullable

next_date

Next available date of the listing, or null.

string

nullable

order_type

Listing type of the listing. Present only when the listing has one.

object

object

string

integer

title

string

transaction_type

string

nullable

enable_cart

boolean

settings

Settings inherited from the listing type (which fields are enabled, whether listings need approval, button label…). Present only when the listing has a listing type.

object

booking_type

string

nullable

calendar_enabled

boolean

contact_supplier_enabled

boolean

contact_supplier_label

string

nullable

display_map

boolean

display_on_homepage

boolean

free_label

string

nullable

listings_needs_approval

boolean

listings_approval_email

boolean

listings_always_accessible_via_url

boolean

listings_editable_offline

boolean

live_preview_active

boolean

live_preview_label

string

nullable

max_image_number

integer

nullable

min_qty_enabled

boolean

order_btn_text

string

nullable

original_price_enabled

boolean

payment_enabled

boolean

price_enabled

boolean

requires_billing

boolean

shipping_enabled

boolean

sku_enabled

boolean

stock_enabled

boolean

digital_assets_enabled

boolean

upload_images_enabled

boolean

use_supplier_avatar_as_listing_cover

boolean

weight_enabled

boolean

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

{
  "listings": [
    {
      "object": "Listing",
      "id": 4242,
      "add_ons": [
        {
          "object": "Addon",
          "id": 17,
          "listing_id": 4242,
          "price": 5,
          "title": "Gift wrapping"
        }
      ],
      "address": {
        "location": "10 Main Street, Springfield",
        "city": "Springfield",
        "state": "IL",
        "country": "US"
      },
      "admin_status": "waiting",
      "attributes": {
        "color": "Blue",
        "size": [
          "S",
          "M"
        ]
      },
      "category": {
        "object": "Category",
        "id": 31,
        "parent_id": 12,
        "title": "Bikes",
        "slug": "bikes",
        "url": "/c/bikes"
      },
      "city": "Springfield",
      "country": "US",
      "cover": "https://cdn.example.com/listings/4242/front.jpg",
      "currency": "USD",
      "date_online": "2026-10-01 09:30:00",
      "external_id": "REF-4242",
      "formatted_price": "$120.00",
      "lat": 39.7817,
      "lng": -89.6501,
      "location": "10 Main Street, Springfield",
      "logistic_category": {
        "object": "LogisticCategory",
        "id": 3,
        "title": "Small parcels"
      },
      "min_qty": 1,
      "medias": [
        {
          "object": "Media",
          "id": 9001,
          "position": 0,
          "media_type": "image",
          "src": "https://cdn.example.com/listings/4242/front.jpg"
        }
      ],
      "media_videos": [
        {
          "object": "MediaVideo",
          "id": 77,
          "position": 0,
          "media_type": "video",
          "src": "https://youtu.be/dQw4w9WgXcQ"
        }
      ],
      "metafields": {
        "global": {
          "warranty_years": "2"
        }
      },
      "original_price": 150,
      "price": 120,
      "price_unit": "night",
      "price_with_currency": "$120.00",
      "status": "draft",
      "quantity": 12,
      "requires_shipping": true,
      "sku": "SKU-4242",
      "state": "IL",
      "shipping_methods": [
        {
          "id": 1,
          "object": "ShippingMethod",
          "carrier_alias": "ups",
          "price": 4.95,
          "sort_priority": 1,
          "step_price": 1,
          "title": "Standard delivery"
        }
      ],
      "slug": "blue-city-bike",
      "title": "Blue city bike",
      "url": "https://acme.mykreezalid.com/listing/4242-blue-city-bike",
      "variants": [
        {
          "object": "Variant",
          "id": 5150,
          "listing_id": 4242,
          "price": 120,
          "quantity": 4,
          "sort_priority": 1,
          "sku": "SKU-4242-M",
          "title": "Size M",
          "weight": 12.5
        }
      ],
      "visibility": "both",
      "weight": 12.5,
      "weight_unit": "kg",
      "_geoloc": {
        "lat": 39.7817,
        "lng": -89.6501
      },
      "owner": {
        "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"
      },
      "user": {
        "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"
      },
      "supplier": {
        "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"
      },
      "order_type": {
        "object": "OrderType",
        "id": 20,
        "title": "Products"
      }
    }
  ],
  "pagination": {
    "totalResultsCount": 137,
    "currentPage": 1,
    "resultOnPageCount": 25,
    "pageCount": 6
  }
}

403

No valid access token was sent.

application/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"
}