> ## 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 reviews > List guest ratings from the check-in and checkout surveys, newest first. ## OpenAPI ````yaml GET /v1/workspaces/{workspace_id}/portal-reviews 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-reviews: get: tags: - portals summary: List Portal Reviews description: >- List guest ratings from the portal's check-in and checkout surveys, newest first. Every filter is optional and filters combine. A page can be short or empty while has_more is true, so keep following next_cursor until has_more is false. operationId: listPortalReviews parameters: - schema: type: string description: Workspace identifier required: true description: Workspace identifier name: workspace_id in: path - schema: type: string required: false name: contact_id in: query - schema: type: string required: false name: reservation_id in: query - schema: type: string enum: - during_stay - after_checkout required: false name: stage in: query - schema: type: integer minimum: 1 maximum: 5 required: false name: min_rating in: query - schema: type: integer minimum: 1 maximum: 5 required: false name: max_rating in: query - schema: type: string required: false name: listing_id in: query - schema: type: string required: false name: submitted_after in: query - schema: type: string required: false name: submitted_before in: query - schema: type: integer minimum: 1 maximum: 100 required: false name: limit in: query - schema: type: string required: false name: cursor in: query responses: '200': description: List Portal Reviews content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string stage: type: string enum: - during_stay - after_checkout description: >- during_stay is the check-in survey; after_checkout is the checkout survey rating: type: integer description: Stars from 1 to 5 comment: type: string nullable: true description: What the guest wrote, or null when they only rated photo_urls: type: array items: type: string guest_name: type: string listing_id: type: string nullable: true description: PMS listing ID listing_name: type: string check_in_date: type: string nullable: true check_out_date: type: string nullable: true confirmation_code: type: string nullable: true booking_channel: type: string nullable: true review_link_opened: type: object nullable: true properties: label: type: string at: type: string format: date-time required: - label - at description: >- The review link the guest opened after rating 5 stars review_left_at: type: string nullable: true format: date-time description: When the guest said they left a review feedback_sent_at: type: string nullable: true format: date-time description: When the guest sent their comment or photos rated_at: type: string format: date-time submitted_at: type: string format: date-time test_mode: type: boolean contact_id: type: string reservation_id: type: string nullable: true description: Conduit reservation ID, for get_reservation pms_reservation_id: type: string nullable: true session_id: type: string description: Portal session ID, for get_portal_session template_id: type: string nullable: true template_name: type: string nullable: true required: - id - stage - rating - comment - photo_urls - guest_name - listing_id - listing_name - check_in_date - check_out_date - confirmation_code - booking_channel - review_link_opened - review_left_at - feedback_sent_at - rated_at - submitted_at - test_mode - contact_id - reservation_id - pms_reservation_id - session_id - template_id - template_name 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 `. Read/write endpoints require a token with write access. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.