> ## 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 guests

> Returns the team's guests sorted by name. Search by name or email with `search`. Cursor-paginated: follow
`links.next`; `per_page` defaults to 20.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/guests
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/guests:
    get:
      tags:
        - Guests
      summary: List guests
      description: >-
        Returns the team's guests sorted by name. Search by name or email with
        `search`. Cursor-paginated: follow

        `links.next`; `per_page` defaults to 20.
      operationId: v1.guests.index
      parameters:
        - name: search
          in: query
          schema:
            type: string
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: Paginated set of `GuestResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/GuestResource'
                  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:
                      path:
                        type:
                          - string
                          - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                        minimum: 0
                      next_cursor:
                        type:
                          - string
                          - 'null'
                        description: The "cursor" that points to the next set of items.
                      prev_cursor:
                        type:
                          - string
                          - 'null'
                        description: The "cursor" that points to the previous set of items.
                    required:
                      - path
                      - per_page
                      - next_cursor
                      - prev_cursor
                required:
                  - data
                  - links
                  - meta
        '401':
          $ref: '#/components/responses/AuthenticationException'
components:
  schemas:
    GuestResource:
      type: object
      properties:
        id:
          type: string
        name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        created_at:
          type: string
      required:
        - id
        - name
        - email
        - phone
        - notes
        - created_at
      title: GuestResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
  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.