> ## 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 Session > Get a portal session with submitted fields, progress, orders, tickets, and stored assets. ## OpenAPI ````yaml GET /v1/workspaces/{workspace_id}/portal-sessions/{session_id} 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/{session_id}: get: tags: - portals summary: Get Portal Session description: >- Get one portal session with reservation-scoped check-in progress, every submitted field, safe order summaries, ticket references, and downloadable Conduit-stored assets. Provider-hosted files are reported as unavailable rather than omitted. operationId: getPortalSession parameters: - schema: type: string minLength: 1 description: Workspace identifier required: true description: Workspace identifier name: workspace_id in: path - schema: type: string minLength: 1 description: Portal session identifier required: true description: Portal session identifier name: session_id in: path responses: '200': description: Get Portal Session content: application/json: schema: type: object properties: data: type: object properties: session: 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 delivery_failure_reason: type: string nullable: true 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 - delivery_failure_reason contact: type: object properties: id: type: string minLength: 1 full_name: type: string email: type: string nullable: true phone: type: string nullable: true required: - id - full_name - email - phone reservation: type: object nullable: true properties: id: type: string minLength: 1 external_id: type: string channel_reservation_id: type: string nullable: true confirmation_code: type: string nullable: true pms_platform: type: string arrival_date: type: string departure_date: type: string required: - id - external_id - channel_reservation_id - confirmation_code - pms_platform - arrival_date - departure_date submission: type: object nullable: true properties: id: type: string minLength: 1 scope: type: string enum: - reservation - session origin_session_id: type: string minLength: 1 created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - scope - origin_session_id - created_at - updated_at tickets: type: array items: type: object properties: id: type: string minLength: 1 delivered_at: type: string format: date-time required: - id - delivered_at 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 steps: type: array items: oneOf: - type: object properties: step_type: type: string enum: - agreement state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: submissions: type: array items: type: object properties: instance_id: type: string signed_at: type: string format: date-time signature_name: type: string title: type: string body: type: string field_responses: type: array items: type: object properties: field_id: type: string kind: type: string enum: - short_text - long_text - email - phone - date - checkbox - select - multi_select - acknowledgment - initials value: anyOf: - type: string - type: boolean - type: array items: type: string required: - field_id - kind - value required: - instance_id - signed_at - signature_name - title - body - field_responses required: - submissions required: - step_type - state - completed_at - waived - details - type: object properties: step_type: type: string enum: - damage_waiver state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: signed_at: type: string format: date-time signature_name: type: string title: type: string body: type: string paid_at: type: string nullable: true format: date-time paid_amount_in_cents: type: integer nullable: true currency: type: string nullable: true field_responses: type: array items: type: object properties: field_id: type: string kind: type: string enum: - short_text - long_text - email - phone - date - checkbox - select - multi_select - acknowledgment - initials value: anyOf: - type: string - type: boolean - type: array items: type: string required: - field_id - kind - value required: - signed_at - signature_name - title - body - paid_at - paid_amount_in_cents - currency - field_responses required: - step_type - state - completed_at - waived - details - type: object properties: step_type: type: string enum: - id_check state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: submitted_at: type: string format: date-time status: type: string enum: - pending - submitted - approved - rejected reviewed_at: type: string nullable: true format: date-time review_note: type: string nullable: true provider: type: string enum: - conduit - didit didit_status: type: string nullable: true document_type: type: string nullable: true enum: - drivers_license - passport - state_id - other document_type_label: type: string nullable: true full_name: type: string nullable: true date_of_birth: type: string nullable: true issuing_country: type: string nullable: true expiry_date: type: string nullable: true liveness_score: type: number nullable: true face_match_score: type: number nullable: true warnings: type: array items: type: object properties: risk: type: string type: type: string description: type: string required: - risk - type - description ai_review: type: object nullable: true properties: reviewed_at: type: string format: date-time model: type: string status: type: string enum: - passed - failed - uncertain document_readable: type: boolean name_matches: type: boolean nullable: true face_matches: type: boolean nullable: true reason: type: string required: - reviewed_at - model - status - document_readable - name_matches - face_matches - reason required: - submitted_at - status - reviewed_at - review_note - provider - didit_status - document_type - document_type_label - full_name - date_of_birth - issuing_country - expiry_date - liveness_score - face_match_score - warnings - ai_review required: - step_type - state - completed_at - waived - details - type: object properties: step_type: type: string enum: - security_deposit state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: status: type: string enum: - pending_setup - scheduled - processing - action_required - pending_authorization - authorized - charged - renewal_required - renewed - released - captured - failed - canceled amount_in_cents: type: integer currency: type: string setup_completed_at: type: string nullable: true format: date-time authorization_scheduled_at: type: string nullable: true format: date-time authorized_at: type: string nullable: true format: date-time release_eligible_at: type: string nullable: true format: date-time released_at: type: string nullable: true format: date-time captured_at: type: string nullable: true format: date-time captured_amount_in_cents: type: integer nullable: true required: - status - amount_in_cents - currency - setup_completed_at - authorization_scheduled_at - authorized_at - release_eligible_at - released_at - captured_at - captured_amount_in_cents required: - step_type - state - completed_at - waived - details - type: object properties: step_type: type: string enum: - mandatory_fee state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: paid_at: type: string format: date-time status: type: string enum: - pending - paid - refunded - failed - canceled amount_in_cents: type: integer currency: type: string title: type: string instructions: type: string line_items: type: array items: type: object properties: instance_id: type: string amount_in_cents: type: integer currency: type: string title: type: string instructions: type: string required: - instance_id - amount_in_cents - currency - title - instructions required: - paid_at - status - amount_in_cents - currency - title - instructions - line_items required: - step_type - state - completed_at - waived - details - type: object properties: step_type: type: string enum: - guest_details state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: submitted_at: type: string format: date-time full_name: type: string nullable: true email: type: string nullable: true phone: type: string nullable: true eta: type: string nullable: true etd: type: string nullable: true required: - submitted_at - full_name - email - phone - eta - etd required: - step_type - state - completed_at - waived - details - type: object properties: step_type: type: string enum: - additional_questions state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: sets: type: array items: type: object properties: instance_id: type: string title: type: string nullable: true submitted_at: type: string format: date-time answers: type: array items: type: object properties: question_id: type: string label: type: string type: type: string nullable: true enum: - text - long_text - single_select - multi_select - checkbox - attachment value: type: string selected_values: type: array nullable: true items: type: string checked: type: boolean nullable: true attachments: type: array items: type: object properties: file_name: type: string nullable: true content_type: type: string nullable: true download_url: type: string nullable: true format: uri required: - file_name - content_type - download_url required: - question_id - label - type - value - selected_values - checked - attachments required: - instance_id - title - submitted_at - answers required: - sets required: - step_type - state - completed_at - waived - details - type: object properties: step_type: type: string enum: - other_guests state: type: string enum: - pending - completed - waived completed_at: type: string nullable: true format: date-time waived: type: object nullable: true properties: at: type: string nullable: true format: date-time by_name: type: string nullable: true reason: type: string nullable: true required: - at - by_name - reason details: type: object nullable: true properties: submitted_at: type: string format: date-time guests: type: array items: type: object properties: guest_index: type: integer minimum: 0 full_name: type: string email: type: string nullable: true phone: type: string nullable: true fields: type: array items: type: object properties: field_id: type: string label: type: string type: type: string nullable: true enum: - text - email - phone - image value: type: string nullable: true image_file_name: type: string nullable: true required: - field_id - label - type - value - image_file_name required: - guest_index - full_name - email - phone - fields required: - submitted_at - guests required: - step_type - state - completed_at - waived - details required: - status - next_step - counts - steps orders: type: array items: type: object properties: id: type: string minLength: 1 kind: type: string enum: - purchase - request status: type: string enum: - pending - succeeded - failed - refunded - requested - declined - expired buyer_contact_id: type: string minLength: 1 currency: type: string subtotal_in_cents: type: integer tax_in_cents: type: integer total_in_cents: type: integer items: type: array items: type: object properties: offer_id: type: string minLength: 1 name: type: string unit_amount_in_cents: type: integer quantity: type: integer total_in_cents: type: integer required: - offer_id - name - unit_amount_in_cents - quantity - total_in_cents form_inputs: type: array items: type: object properties: block_id: type: string name: type: string label: type: string value: type: string required: - block_id - name - label - value created_at: type: string format: date-time purchased_at: type: string nullable: true format: date-time failed_at: type: string nullable: true format: date-time refunded_at: type: string nullable: true format: date-time required: - id - kind - status - buyer_contact_id - currency - subtotal_in_cents - tax_in_cents - total_in_cents - items - form_inputs - created_at - purchased_at - failed_at - refunded_at assets: type: array items: type: object properties: kind: type: string enum: - id_document - contact_photo - signature - signed_pdf - question_attachment - other_guest_image step_type: type: string enum: - agreement - damage_waiver - id_check - security_deposit - mandatory_fee - guest_details - additional_questions - other_guests document_type: type: string nullable: true enum: - drivers_license - passport - state_id - other subject: oneOf: - type: object properties: type: type: string enum: - contact contact_id: type: string minLength: 1 required: - type - contact_id - type: object properties: type: type: string enum: - other_guest guest_index: type: integer minimum: 0 full_name: type: string required: - type - guest_index - full_name field: type: object nullable: true properties: id: type: string label: type: string required: - id - label field_path: type: string file_name: type: string nullable: true content_type: type: string nullable: true download_url: type: string nullable: true format: uri url_expires_at: type: string nullable: true format: date-time unavailable_reason: type: string nullable: true enum: - provider_hosted - not_stored - deleted required: - kind - step_type - document_type - subject - field - field_path - file_name - content_type - download_url - url_expires_at - unavailable_reason required: - session - contact - reservation - submission - tickets - progress - orders - assets 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 `. Read/write endpoints require a token with write access. ````