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

# Get the receptionist settings

> How the receptionist greets callers, what it says about the business, when it transfers calls and what it may book.



## OpenAPI

````yaml /api-reference/openapi.json get /receptionist
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: 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
paths:
  /receptionist:
    get:
      tags:
        - Receptionist
      summary: Get the receptionist settings
      description: >-
        How the receptionist greets callers, what it says about the business,
        when it transfers calls and what it may book.
      operationId: getReceptionist
      parameters:
        - name: LobbyStack-Business
          in: header
          description: >-
            The business a platform key acts on. Required with a platform key. A
            per-business key may leave it out; if it sends one, it must be the
            key's own business.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/Receptionist'
        '400':
          description: >-
            The request is invalid (invalid_request), or a platform key sent no
            LobbyStack-Business header (business_required).
          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 business:read scope.
            forbidden: a per-business key named another business in
            LobbyStack-Business. 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'
        '404':
          description: A platform key named a business it cannot act on (not_found).
          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:
    Receptionist:
      type: object
      properties:
        greeting:
          type: string
          description: What the receptionist says when it answers.
        tone:
          type: string
          description: How it speaks, such as professional or warm.
        summary:
          type: string
          description: >-
            What it tells callers the business does. Calls leave it out while
            summary_source is placeholder.
        summary_source:
          type: string
          enum:
            - placeholder
            - generated
            - operator
          description: >-
            placeholder: the default from sign-up. generated: written by AI from
            the business's knowledge. operator: written by a person or through
            the API, and AI never replaces it.
        booking_policy:
          type: string
          description: Rules it follows when it books.
        voice_instructions:
          description: Extra instructions for calls.
          type:
            - string
            - 'null'
        sms_instructions:
          description: Extra instructions for text messages.
          type:
            - string
            - 'null'
        chat_instructions:
          description: Extra instructions for website chat.
          type:
            - string
            - 'null'
        transfer_mode:
          type: string
          enum:
            - never
            - always
            - on_request
            - on_urgent
            - during_business_hours
          description: >-
            When it puts a caller through to transfer_number: never, always,
            on_request, on_urgent or during_business_hours.
        transfer_number:
          description: >-
            Where it transfers calls, in E.164 format. A number saved before
            that was required may be in another format. With no number, it never
            transfers.
          type:
            - string
            - 'null'
        booking_mode:
          type: string
          enum:
            - 'off'
            - request
            - instant
          description: >-
            instant: appointments are booked directly. request: the receptionist
            takes a request and the team confirms it. off: no booking.
        appointment_change_policy:
          type: object
          properties:
            enabled:
              type: boolean
              description: >-
                Whether callers can change their own appointments with the
                receptionist.
            allow_cancel:
              type: boolean
            allow_reschedule:
              type: boolean
            verification_mode:
              type: string
              enum:
                - phone_match_and_facts
                - otp_required
                - passcode_required
                - operator_only
              description: >-
                How a caller proves an appointment is theirs.
                phone_match_and_facts: their phone number and details of the
                booking. otp_required: a code sent by text. passcode_required: a
                PIN they type on the phone keypad, set on their contact in the
                dashboard. operator_only: the team makes the change.
          required:
            - enabled
            - allow_cancel
            - allow_reschedule
            - verification_mode
          additionalProperties: false
          description: >-
            Whether callers can cancel or reschedule their own appointments, and
            how they prove it's theirs.
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp in UTC.
      required:
        - greeting
        - tone
        - summary
        - summary_source
        - booking_policy
        - voice_instructions
        - sms_instructions
        - chat_instructions
        - transfer_mode
        - transfer_number
        - booking_mode
        - appointment_change_policy
        - updated_at
      additionalProperties: false
      description: >-
        How the receptionist answers, what it says about the business, and what
        it may do.
    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
            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. Only platform keys can
        hold businesses:create and users:create.

````

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