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

# List Portal Sessions

> List portal sessions with contact and reservation references and check-in progress.



## OpenAPI

````yaml GET /v1/workspaces/{workspace_id}/portal-sessions
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: >-
      V2 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 V2 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
      `inboxTypeId` 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-sessions:
    get:
      tags:
        - portals
      summary: List Portal Sessions
      description: >-
        List portal sessions with contact and reservation references plus
        check-in progress counts. Use get_portal_session for submitted fields
        and uploaded assets.
      operationId: listPortalSessions
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Workspace identifier
          required: true
          description: Workspace identifier
          name: workspace_id
          in: path
        - schema:
            type: string
            minLength: 1
          required: false
          name: contact_id
          in: query
        - schema:
            type: string
            minLength: 1
          required: false
          name: reservation_id
          in: query
        - schema:
            type: string
            enum:
              - outstanding
              - completed
              - expired
              - delivery_failed
          required: false
          name: state
          in: query
        - schema:
            type: string
          required: false
          name: cursor
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 25
          required: false
          name: limit
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
          required: false
          name: order
          in: query
      responses:
        '200':
          description: List Portal Sessions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        workspace_id:
                          type: string
                          minLength: 1
                        template_id:
                          type: string
                          minLength: 1
                        template_name:
                          type: string
                          nullable: true
                        contact_id:
                          type: string
                          minLength: 1
                        reservation_id:
                          type: string
                          nullable: true
                          minLength: 1
                        submission_id:
                          type: string
                          nullable: true
                          minLength: 1
                        state:
                          type: string
                          enum:
                            - outstanding
                            - completed
                            - expired
                            - delivery_failed
                        status:
                          type: string
                          enum:
                            - active
                            - completed
                            - expired
                        source_channel:
                          type: string
                          enum:
                            - auto
                            - sms
                            - whatsapp
                            - email
                        created_at:
                          type: string
                          format: date-time
                        expires_at:
                          type: string
                          format: date-time
                        viewed_at:
                          type: string
                          nullable: true
                          format: date-time
                        completed_at:
                          type: string
                          nullable: true
                          format: date-time
                        last_interaction_at:
                          type: string
                          nullable: true
                          format: date-time
                        delivered_at:
                          type: string
                          nullable: true
                          format: date-time
                        delivery_failed_at:
                          type: string
                          nullable: true
                          format: date-time
                        progress:
                          type: object
                          properties:
                            status:
                              type: string
                              enum:
                                - not_started
                                - needs_agreement
                                - needs_signature
                                - needs_id
                                - needs_review
                                - needs_deposit
                                - needs_fee
                                - needs_details
                                - needs_questions
                                - needs_guests
                                - rejected
                                - ready
                            next_step:
                              type: string
                              nullable: true
                              enum:
                                - agreement
                                - damage_waiver
                                - id_check
                                - security_deposit
                                - mandatory_fee
                                - guest_details
                                - additional_questions
                                - other_guests
                            counts:
                              type: object
                              properties:
                                total:
                                  type: integer
                                  minimum: 0
                                completed:
                                  type: integer
                                  minimum: 0
                                pending:
                                  type: integer
                                  minimum: 0
                                waived:
                                  type: integer
                                  minimum: 0
                              required:
                                - total
                                - completed
                                - pending
                                - waived
                          required:
                            - status
                            - next_step
                            - counts
                      required:
                        - id
                        - workspace_id
                        - template_id
                        - template_name
                        - contact_id
                        - reservation_id
                        - submission_id
                        - state
                        - status
                        - source_channel
                        - created_at
                        - expires_at
                        - viewed_at
                        - completed_at
                        - last_interaction_at
                        - delivered_at
                        - delivery_failed_at
                        - progress
                  next_cursor:
                    type: string
                    nullable: true
                  has_more:
                    type: boolean
                required:
                  - data
                  - next_cursor
                  - has_more
        '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.

````