> ## Documentation Index
> Fetch the complete documentation index at: https://docs.way.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get featured listings

> Returns the brand's featured listings, in the order configured in the dashboard.



## OpenAPI

````yaml get /v3/listings/featured
openapi: 3.0.0
info:
  title: Way Partner API
  description: >-
    REST API for Way partners: list experiences, check availability, run
    checkout, and manage bookings.
  version: '1.0'
servers:
  - url: https://api.letsway.com
    description: Production.
  - url: https://api.staging.letsway.com
    description: Staging.
security: []
tags:
  - name: Listings
    description: 'Retrieve the listings a brand offers: experiences, events, and resources.'
  - name: Availability
    description: Dates, sessions, and price tiers for scheduling a booking.
  - name: Carts & Checkout
    description: >-
      Payment intents and booking creation. The cart ID is a client-generated
      UUID; there is no create-cart endpoint.
  - name: Bookings
    description: Retrieve, cancel, and reschedule bookings.
  - name: Experiences
    description: Experience details, settings, custom questions, reviews, and hosts.
  - name: Brand Configuration
    description: Brand settings, taxonomy, terms, and promotion code validation.
  - name: Waitlists
    description: Waitlists for sold-out sessions and invitation handling.
  - name: Integrations
    description: Configured integrations, analytics, and room-charge validation.
  - name: Organizations
    description: Organization-level access across brands.
paths:
  /v3/listings/featured:
    get:
      tags:
        - Listings
      summary: Get featured listings
      description: >-
        Returns the brand's featured listings, in the order configured in the
        dashboard.
      operationId: ListingV3PublicController_get
      parameters:
        - $ref: '#/components/parameters/isUnlistedQuery_0'
        - $ref: '#/components/parameters/languageQuery_1'
        - $ref: '#/components/parameters/versionQuery'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetListingsV3FeaturedPublicResponse'
              example:
                data:
                  - advertisedPrice: 10
                    bookingAvailabilityMode: null
                    category: null
                    eventDates: null
                    experienceId: null
                    hidePrice: false
                    hostedBy: null
                    id: 40aec576-8993-490e-bc92-04ec38837c61
                    isExclusive: false
                    isUnlisted: false
                    kind: resource
                    maxParticipants: 1
                    medias:
                      - id: 24e3c523-dcd9-49f8-8e1e-b98d798233b0
                        kind: cover
                        type: image
                        links:
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: original
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '384'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '480'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '640'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '750'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '1080'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: original
                        altText: null
                    order: 1
                    pointsEligible: null
                    pricePerType: thrid
                    productLine: reserve
                    rating: null
                    resourceGroupCollectionId: 9ce5652d-991b-4bd8-b8a9-d0d6ad26a974
                    slug: null
                    startingPrice: 10
                    summary: >-
                      Indulge in luxury with our Adult Cabana and Daybed,
                      offering private relaxation, personal butler service, and
                      plush comfort in a serene, sophisticated setting.
                    title: Cabanas & Daybeds
                    vibes: []
                  - advertisedPrice: 400
                    bookingAvailabilityMode: null
                    category: null
                    eventDates: null
                    experienceId: null
                    hidePrice: false
                    hostedBy: null
                    id: 778909d7-2d88-4eda-878e-8b7f4777e255
                    isExclusive: false
                    isUnlisted: false
                    kind: resource
                    maxParticipants: 1
                    medias:
                      - id: 2e29bccf-8b3d-4f10-bcf0-f97c79a098fa
                        kind: cover
                        type: image
                        links:
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: original
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '384'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '480'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '640'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '750'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: '1080'
                          - type: image
                            url: >-
                              https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                            resolution: original
                        altText: null
                    order: 2
                    pointsEligible: null
                    pricePerType: adult cabana
                    productLine: reserve
                    rating: null
                    resourceGroupCollectionId: e881831a-92a6-44d0-84cf-523a5986c030
                    slug: null
                    startingPrice: 400
                    summary: A morning yoga session on the ocean terrace.
                    title: Garden View Room
                    vibes: []
      security:
        - Brand-API-Key: []
components:
  parameters:
    isUnlistedQuery_0:
      name: isUnlisted
      in: query
      schema:
        default: false
        oneOf:
          - type: boolean
          - type: string
            enum:
              - 'true'
          - type: string
            enum:
              - 'false'
      description: >-
        Set to `true` to return unlisted listings instead of publicly listed
        ones.
      required: false
    languageQuery_1:
      name: language
      in: query
      schema:
        type: string
      description: Locale for translated content; defaults to the brand's language.
      required: false
    versionQuery:
      name: version
      in: query
      schema:
        default: published
        type: string
        enum:
          - latest
          - published
      description: >-
        Which content version to return: the published version (default) or the
        latest draft.
      required: false
  schemas:
    GetListingsV3FeaturedPublicResponse:
      type: array
      items:
        type: object
        properties:
          advertisedPrice:
            type: number
            nullable: true
            example: 10
          bookingAvailabilityMode:
            type: string
            enum:
              - private
              - group
              - non-restricted
            nullable: true
          category:
            type: object
            properties:
              id:
                type: string
                format: uuid
              brandId:
                type: string
                format: uuid
              name:
                type: string
            required:
              - id
              - brandId
              - name
            nullable: true
          eventDates:
            type: array
            items:
              type: string
              format: date-time
            nullable: true
          experienceId:
            type: string
            format: uuid
            nullable: true
          hidePrice:
            type: boolean
            nullable: true
            example: false
          hostedBy:
            type: object
            properties:
              id:
                type: string
                format: uuid
              firstName:
                type: string
              lastName:
                type: string
              description:
                type: string
                nullable: true
              profilePicture:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  uri:
                    type: object
                    properties:
                      360w:
                        type: string
                      720w:
                        type: string
                      1080w:
                        type: string
                      original:
                        type: string
                    required:
                      - 360w
                      - 720w
                      - 1080w
                      - original
                required:
                  - id
                  - uri
                nullable: true
            required:
              - id
              - firstName
              - lastName
            nullable: true
          id:
            type: string
            format: uuid
            example: 40aec576-8993-490e-bc92-04ec38837c61
          isExclusive:
            type: boolean
            example: false
          isUnlisted:
            type: boolean
            example: false
          kind:
            type: string
            enum:
              - experience
              - resource
              - event
              - auction
            example: resource
          maxParticipants:
            type: number
            nullable: true
            example: 1
          medias:
            type: array
            items:
              type: object
              properties:
                id:
                  type: string
                  format: uuid
                  example: 24e3c523-dcd9-49f8-8e1e-b98d798233b0
                kind:
                  type: string
                  enum:
                    - gallery
                    - cover
                    - map
                    - description
                  example: cover
                type:
                  type: string
                  enum:
                    - image
                    - video
                  example: image
                links:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - image
                          - video
                        example: image
                      url:
                        type: string
                        format: uri
                        example: >-
                          https://images.letsway.com/staging/tr:w-original/https://storage.googleapis.com/kouto-api-media/2026/6/accbde4c0064e535c67fd874a3b95d235d72465ed862dca1.jpg
                      resolution:
                        type: string
                        enum:
                          - original
                          - adaptative
                          - '240'
                          - '360'
                          - '480'
                          - '540'
                          - '640'
                          - '720'
                          - '1080'
                          - '384'
                          - '480'
                          - '640'
                          - '750'
                          - '1080'
                        example: original
                    required:
                      - type
                      - url
                      - resolution
                altText:
                  type: string
                  nullable: true
              required:
                - id
                - kind
                - type
                - links
          order:
            type: number
            nullable: true
            example: 1
          pointsEligible:
            type: object
            properties:
              org:
                type: string
              payEligible:
                type: boolean
              earnEligible:
                type: boolean
            required:
              - org
              - payEligible
              - earnEligible
            nullable: true
          pricePerType:
            type: string
            nullable: true
            example: thrid
          productLine:
            type: string
            enum:
              - activate
              - host
              - reserve
            example: reserve
          rating:
            type: number
            nullable: true
          resourceGroupCollectionId:
            type: string
            format: uuid
            nullable: true
            example: 9ce5652d-991b-4bd8-b8a9-d0d6ad26a974
          slug:
            type: string
            nullable: true
          startingPrice:
            type: number
            nullable: true
            example: 10
          summary:
            type: string
            nullable: true
            example: >-
              Indulge in luxury with our Adult Cabana and Daybed, offering
              private relaxation, personal butler service, and plush comfort in
              a serene, sophisticated setting.
          title:
            type: string
            nullable: true
            example: Cabanas & Daybeds
          vibes:
            type: array
            items:
              type: object
              properties:
                id:
                  type: string
                  format: uuid
                brandId:
                  type: string
                  format: uuid
                name:
                  type: string
              required:
                - id
                - brandId
                - name
        required:
          - id
          - isExclusive
          - isUnlisted
          - kind
          - medias
          - productLine
          - vibes
  securitySchemes:
    Brand-API-Key:
      type: http
      scheme: bearer
      description: >-
        Your brand's secret API key, e.g. `Bearer
        way_sk_live_bhEqcn0i1fRoUEHBPjJkQA`. Older `Way-Brand-Id` +
        `Way-Secret-Key` credentials still work: see [Legacy
        authentication](/legacy-authentication).

````