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

# List prospect demos

> The partner's demos, newest first, all in one page, with what each still waits for before it can be published.



## OpenAPI

````yaml /api-reference/openapi.json get /partner/demos
openapi: 3.1.0
info:
  title: LobbyStack API
  version: v1
  description: >-
    Read calls, contacts, appointments and messages, book appointments, and
    subscribe to webhooks. Authenticate with an API key in the Authorization
    header. A platform key also names the business it acts on in the
    LobbyStack-Business header. Each key allows 120 requests per minute by
    default.
servers:
  - url: https://app.lobbystack.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Business
  - name: Receptionist
  - name: Agents
  - name: Billing
  - name: Phone numbers
  - name: Onboarding
  - name: Team
  - name: Website chat
  - name: Calendars
  - name: Notifications
  - name: Calls
  - name: Contacts
  - name: Appointments
  - name: Messages
  - name: Knowledge
  - name: Webhooks
  - name: Platform
  - name: Partner
paths:
  /partner/demos:
    get:
      tags:
        - Partner
      summary: List prospect demos
      description: >-
        The partner's demos, newest first, all in one page, with what each still
        waits for before it can be published.
      operationId: listPartnerDemos
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - next_cursor
                  - has_more
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PartnerDemo'
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Pass as cursor to get the next page. Null on the last
                      page.
                  has_more:
                    type: boolean
        '400':
          description: The request is invalid (invalid_request).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key is missing, invalid, or revoked (unauthorized).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Refused. insufficient_scope: the key lacks the partner:read scope.
            forbidden: only a partner's platform keys can call this endpoint, or
            what only the partner's owners may do. key_owner_inactive: the
            person the key acts for can't any more: a per-business key's creator
            is no longer an owner or admin, or a platform key's owner_email has
            no verified LobbyStack account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Too many requests (rate_limited). Wait for the Retry-After header's
            number of seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait.
      security:
        - bearerAuth: []
components:
  schemas:
    PartnerDemo:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Stable identifier (UUID).
        business_id:
          type: string
          format: uuid
          description: Stable identifier (UUID).
        business_name:
          type: string
        website_url:
          type: string
        status:
          type: string
          description: preparing, active, claimed, revoked or expired.
        locale:
          type: string
        access_level:
          type: string
          enum:
            - full
            - activity
        suggested_prompts:
          type: array
          items:
            type: string
        expires_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp in UTC.
        published_at:
          anyOf:
            - type: string
              format: date-time
              description: ISO 8601 timestamp in UTC.
            - type: 'null'
        ready:
          type: object
          properties:
            website:
              type: boolean
              description: The website crawl finished, or this deployment has no crawler.
            greeting:
              type: boolean
            snapshot:
              type: boolean
            prompts:
              type: boolean
              description: At least two suggested prompts.
          required:
            - website
            - greeting
            - snapshot
            - prompts
          additionalProperties: false
          description: What publishing waits for.
        website_status:
          description: The crawl's status, such as queued, running or completed.
          type:
            - string
            - 'null'
        website_error:
          type:
            - string
            - 'null'
        usage:
          type: object
          properties:
            period:
              type: string
              description: The month, YYYY-MM, in UTC.
            voice_seconds:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            chats:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - period
            - voice_seconds
            - chats
          additionalProperties: false
          description: What the business used this month, as usage metering counts it.
      required:
        - id
        - business_id
        - business_name
        - website_url
        - status
        - locale
        - access_level
        - suggested_prompts
        - expires_at
        - published_at
        - ready
        - website_status
        - website_error
        - usage
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - insufficient_scope
                - not_found
                - conflict
                - idempotency_key_reused
                - idempotency_request_in_progress
                - booking_disabled
                - booking_requires_confirmation
                - slot_unavailable
                - rate_limited
                - rate_limit_unavailable
                - method_not_allowed
                - internal_error
                - business_required
                - key_owner_inactive
                - plan_limit_reached
                - phone_numbers_unavailable
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
                required:
                  - path
                  - message
                additionalProperties: false
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Settings > API keys (lsk_...), which acts on its own
        business, or a platform key from the PLATFORM_API_KEYS setting
        (lsp_...), which onboards and manages businesses. Scopes: business:read,
        business:write, calls:read, contacts:read, contacts:write,
        appointments:read, appointments:write, messages:read, knowledge:read,
        knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage,
        team:manage, businesses:create, users:create, phone_numbers:purchase,
        partner:read, partner.businesses:write, partner.demos:write,
        partner.packages:write, partner.branding:write, partner.templates:write,
        partner.team:write, partner.billing:read, partner.billing:write. Only
        platform keys can hold businesses:create and users:create, and only a
        key a partner made in its console can hold the partner scopes, which the
        Partner endpoints use. Only a partner's owners grant
        partner.billing:read and partner.billing:write.

````

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