> ## 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 Listing Fields > Read portal listing fields for every property in the workspace, one page at a time. ## OpenAPI ````yaml GET /v1/workspaces/{workspace_id}/portal-listing-fields 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-listing-fields: get: tags: - portals summary: List Portal Listing Fields description: >- Read the guest portal info for every property in the workspace, a page at a time, in the same shape as get_portal_listing_fields: each field's current value, PMS value, override source, rich-text document, and media URLs. Each row also has property_id and integration_id, which tell apart properties from different PMS accounts that share a listing_id. Use it to snapshot portal info before a bulk change. Subunits are not included. Requires Portals access and AccessProperties permission. operationId: listPortalListingFields parameters: - schema: type: string minLength: 1 description: Workspace identifier required: true description: Workspace identifier name: workspace_id in: path - schema: type: integer minimum: 1 maximum: 50 required: false name: limit in: query - schema: type: string required: false name: cursor in: query responses: '200': description: List Portal Listing Fields content: application/json: schema: type: object properties: data: type: array items: type: object properties: property_id: type: string integration_id: anyOf: - type: string - nullable: true - nullable: true workspace_id: type: string listing_id: type: string subunit_id: anyOf: - type: string - nullable: true - nullable: true fields: type: array items: type: object properties: field: anyOf: - type: string enum: - portalName - type: string enum: - address - type: string enum: - googleMapsUrl - type: string enum: - appleMapsUrl - type: string enum: - directions - type: string enum: - area - type: string enum: - checkInTime - type: string enum: - checkInInstructions - type: string enum: - checkOutTime - type: string enum: - checkOutInstructions - type: string enum: - wifiUsername - type: string enum: - wifiPassword - type: string enum: - parking - type: string enum: - houseRules - type: string enum: - houseManual - type: string enum: - trashLocation - type: string enum: - trashCollection - type: string enum: - doorCode value: anyOf: - type: string - nullable: true - nullable: true pms_value: anyOf: - type: string - nullable: true - nullable: true source: anyOf: - type: string enum: - synced - type: string enum: - manual - type: string enum: - hidden - type: string enum: - missing override_mode: anyOf: - type: string enum: - manual - type: string enum: - hidden - nullable: true - nullable: true document: anyOf: - type: object properties: version: type: number enum: - 1 type: type: string enum: - doc content: type: array items: anyOf: - type: object properties: type: type: string enum: - paragraph content: type: array items: anyOf: - type: object properties: type: type: string enum: - text text: type: string marks: type: array items: anyOf: - type: object properties: type: type: {} enum: {} required: - type - type: object properties: type: type: {} enum: {} required: - type - type: object properties: type: type: {} enum: {} attrs: type: {} properties: {} required: {} required: - type - attrs required: - type - text - type: object properties: type: type: string enum: - hardBreak required: - type - type: object properties: type: type: string enum: - variable attrs: anyOf: - type: object properties: kind: type: string enum: - currentDateTime required: - kind - type: object properties: kind: type: string enum: - global id: type: string required: - kind - id - type: object properties: kind: type: string enum: - deviceCode id: type: string required: - kind - id required: - type - attrs required: - type - type: object properties: type: type: string enum: - heading attrs: type: object properties: level: anyOf: - type: number enum: - 2 - type: number enum: - 3 required: - level content: type: array items: anyOf: - type: object properties: type: type: string enum: - text text: type: string marks: type: array items: anyOf: - type: object properties: type: type: {} enum: {} required: - type - type: object properties: type: type: {} enum: {} required: - type - type: object properties: type: type: {} enum: {} attrs: type: {} properties: {} required: {} required: - type - attrs required: - type - text - type: object properties: type: type: string enum: - hardBreak required: - type - type: object properties: type: type: string enum: - variable attrs: anyOf: - type: object properties: kind: type: string enum: - currentDateTime required: - kind - type: object properties: kind: type: string enum: - global id: type: string required: - kind - id - type: object properties: kind: type: string enum: - deviceCode id: type: string required: - kind - id required: - type - attrs required: - type - attrs - type: object properties: type: anyOf: - type: string enum: - bulletList - type: string enum: - orderedList content: type: array items: type: object properties: type: type: string enum: - listItem content: type: array items: type: object properties: type: type: string enum: - paragraph content: type: array items: anyOf: - type: object properties: type: {} text: {} marks: {} required: - {} - {} - type: object properties: type: {} required: - {} - type: object properties: type: {} attrs: {} required: - {} - {} required: - type required: - type - content required: - type - content - type: object properties: type: type: string enum: - image attrs: type: object properties: storageId: type: string caption: type: string required: - storageId required: - type - attrs - type: object properties: type: type: string enum: - video attrs: type: object properties: storageId: type: string caption: type: string required: - storageId required: - type - attrs required: - version - type - content - nullable: true - nullable: true conflict: type: boolean supports_rich_content: type: boolean required: - field - value - pms_value - source - override_mode - document - conflict - supports_rich_content media: type: array items: type: object properties: storage_id: type: string url: anyOf: - type: string - nullable: true - nullable: true required: - storage_id - url required: - property_id - integration_id - workspace_id - listing_id - subunit_id - fields - media 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.