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

# Get portal settings

> Read the default stay template, auto-provisioning, and payment routing.



## OpenAPI

````yaml GET /v1/workspaces/{workspace_id}/portal-settings
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      Chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inbox_type_id` and as the `inbox_type_id` filter on list conversations.
  - name: workflows
    description: >-
      Workspace automation workflows: definitions, executions, and per-execution
      event timelines.
  - name: insights
    description: Aggregated workspace analytics, such as conversation automation rate.
paths:
  /v1/workspaces/{workspace_id}/portal-settings:
    get:
      tags:
        - portals
      summary: Get Portal Settings
      description: >-
        Get workspace portal settings: the default stay portal template, whether
        a stay portal is created for every booked reservation, the default
        Stripe account, and the payment routing rules that send each listing's
        payments to a Stripe account. Callers with Manage Portal Payments also
        get the connected Stripe accounts.
      operationId: getPortalSettings
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Workspace identifier
          required: true
          description: Workspace identifier
          name: workspace_id
          in: path
      responses:
        '200':
          description: Get Portal Settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      workspace_id:
                        type: string
                      default_stay_template_id:
                        type: string
                        nullable: true
                      auto_provision_stay_portals:
                        type: boolean
                      default_stripe_connection_id:
                        type: string
                        nullable: true
                        description: >-
                          Null uses the only connected account. Once several
                          accounts are connected, payments need a default.
                      stripe_routing_rules:
                        type: array
                        items:
                          type: object
                          properties:
                            targeting:
                              type: object
                              properties:
                                listingIds:
                                  type: array
                                  items:
                                    type: string
                                  description: PMS listing IDs from list_listings
                                listingGroupIds:
                                  type: array
                                  items:
                                    type: string
                                    minLength: 1
                                  description: Listing group IDs from list_listing_groups
                              description: >-
                                Stays at any of these listings or listing
                                groups. Set at least one.
                            stripe_connection_id:
                              type: string
                              minLength: 1
                              description: >-
                                Stripe account from stripe_connections in
                                get_portal_settings
                          required:
                            - targeting
                            - stripe_connection_id
                      stripe_connections:
                        type: array
                        nullable: true
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            stripe_account_id:
                              type: string
                            business_name:
                              type: string
                              nullable: true
                            country:
                              type: string
                            default_currency:
                              type: string
                            charges_enabled:
                              type: boolean
                            onboarding_completed:
                              type: boolean
                            disconnected:
                              type: boolean
                          required:
                            - id
                            - stripe_account_id
                            - business_name
                            - country
                            - default_currency
                            - charges_enabled
                            - onboarding_completed
                            - disconnected
                        description: >-
                          Connected Stripe accounts. Null without Manage Portal
                          Payments.
                      updated_at:
                        type: number
                        nullable: true
                    required:
                      - workspace_id
                      - default_stay_template_id
                      - auto_provision_stay_portals
                      - default_stripe_connection_id
                      - stripe_routing_rules
                      - stripe_connections
                      - updated_at
                required:
                  - data
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````

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