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

# List a booking site's listings

> Returns the listings a team shows on its booking site (active, listed on the site), with photos and, for
buildings, their bookable unit types. No token needed. Paginated with `page` and `per_page` (default 20).



## OpenAPI

````yaml /api-reference/openapi.json get /v1/public/{teamSlug}/listings
openapi: 3.1.0
info:
  title: Overviu API
  version: '1.0'
  description: >-
    Read your listings and availability, and create and manage bookings, from
    your own systems. Authenticate with an API token from **Settings → API
    tokens** in Overviu, sent as `Authorization: Bearer <token>`. Endpoints
    under `/v1/public/{teamSlug}` need no token: they serve what your booking
    site shows. Guides and conventions:
    https://docs.overviu.app/api-reference/introduction
servers:
  - url: https://api.overviu.app/api
    description: Production
security:
  - http: []
tags:
  - name: Account
    description: The team an API token belongs to.
  - name: Listings
    description: The team's listings.
  - name: Availability
    description: Prices and availability for dates.
  - name: Bookings
    description: Create, read, change and cancel the team's bookings.
  - name: Guests
    description: The team's guests.
  - name: Public
    description: What a booking site shows, with no token.
paths:
  /v1/public/{teamSlug}/listings:
    get:
      tags:
        - Public
      summary: List a booking site's listings
      description: >-
        Returns the listings a team shows on its booking site (active, listed on
        the site), with photos and, for

        buildings, their bookable unit types. No token needed. Paginated with
        `page` and `per_page` (default 20).
      operationId: v1.public.listings.index
      parameters:
        - name: teamSlug
          in: path
          required: true
          schema:
            type: string
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: Paginated set of `PublicListingResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicListingResource'
                  links:
                    type: object
                    properties:
                      first:
                        type:
                          - string
                          - 'null'
                      last:
                        type:
                          - string
                          - 'null'
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                    required:
                      - first
                      - last
                      - prev
                      - next
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        minimum: 1
                      from:
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      last_page:
                        type: integer
                        minimum: 1
                      links:
                        type: array
                        description: Generated paginator links.
                        items:
                          type: object
                          properties:
                            url:
                              type:
                                - string
                                - 'null'
                            label:
                              type: string
                            active:
                              type: boolean
                          required:
                            - url
                            - label
                            - active
                      path:
                        type:
                          - string
                          - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                        minimum: 0
                      to:
                        type:
                          - integer
                          - 'null'
                        description: Number of the last item in the slice.
                        minimum: 1
                      total:
                        type: integer
                        description: Total number of items being paginated.
                        minimum: 0
                    required:
                      - current_page
                      - from
                      - last_page
                      - links
                      - path
                      - per_page
                      - to
                      - total
                required:
                  - data
                  - links
                  - meta
      security: []
components:
  schemas:
    PublicListingResource:
      type: object
      properties:
        slug:
          type: string
        kind:
          type: string
        public_title:
          type: string
        property_type:
          type: string
        max_guests:
          type: integer
        bedrooms_count:
          type: integer
        beds_count:
          type: integer
        bathrooms_count:
          type: integer
        bathrooms_half:
          type: boolean
        currency:
          type: string
        timezone:
          type: string
        check_in_time:
          type: string
        check_out_time:
          type: string
        address:
          type: object
          properties:
            city:
              type:
                - string
                - 'null'
            state:
              type:
                - string
                - 'null'
            country:
              type:
                - string
                - 'null'
            latitude:
              type:
                - string
                - 'null'
            longitude:
              type:
                - string
                - 'null'
          required:
            - city
            - state
            - country
            - latitude
            - longitude
        headline:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        photos:
          type: array
          items:
            $ref: '#/components/schemas/ListingPhotoResource'
        unit_types:
          type: array
          items:
            $ref: '#/components/schemas/PublicListingResource'
        whole_building:
          type:
            - object
            - 'null'
          properties:
            max_guests:
              type: integer
            bedrooms:
              type: integer
          required:
            - max_guests
            - bedrooms
      required:
        - slug
        - kind
        - public_title
        - property_type
        - max_guests
        - bedrooms_count
        - beds_count
        - bathrooms_count
        - bathrooms_half
        - currency
        - timezone
        - check_in_time
        - check_out_time
        - address
        - headline
        - description
      title: PublicListingResource
    ListingPhotoResource:
      type: object
      properties:
        id:
          type: string
        is_featured:
          type: boolean
        sort_order:
          type: integer
        width:
          type:
            - integer
            - 'null'
        height:
          type:
            - integer
            - 'null'
        thumbnail_url:
          type: string
        medium_url:
          type: string
        original_url:
          type: string
      required:
        - id
        - is_featured
        - sort_order
        - width
        - height
        - thumbnail_url
        - medium_url
        - original_url
      title: ListingPhotoResource
  securitySchemes:
    http:
      type: http
      description: >-
        An API token from **Settings → API tokens** in Overviu, sent as
        `Authorization: Bearer <token>`.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.