---
title: "List all portals in an account"
method: GET
path: "/v1/workspaces/{workspace_id}/portals"
tags: ["Help center"]
---

# List all portals in an account

`GET /v1/workspaces/{workspace_id}/portals`

## Request

- Base URL: `https://api.oxvo.com`
- URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/portals`
- Auth: API key in header `api_access_token`

Get details of portals in an Account

## Path parameters

- `workspace_id` integer, required

## Response `200`

Success

- Portal
  - `payload` PortalItem[]
    - `id` integer: The ID of the portal
    - `archived` boolean: Whether the portal is archived
    - `color` string: The color code for the portal
    - `config` PortalConfig: Configuration settings for the portal
      - `allowed_locales` object[]: List of allowed locales for the portal
        - `code` string: The language code
        - `articles_count` integer: Number of articles in this locale
        - `categories_count` integer: Number of categories in this locale
    - `custom_domain` string: Custom domain for the portal
    - `header_text` string: The header text for the portal
    - `homepage_link` string: Homepage link for the portal
    - `name` string: Name of the portal
    - `slug` string: URL slug for the portal
    - `page_title` string: Page title for the portal
    - `account_id` integer: ID of the account the portal belongs to
    - `inbox` Inbox
      - `id` number: ID of the inbox
      - `name` string: The name of the inbox
      - `website_url` string: Website URL
      - `channel_type` string: The type of the inbox
      - `avatar_url` string: The avatar image of the inbox
      - `messenger_color` string: Widget Color used for customization of the widget
      - `website_token` string: Website Token
      - `enable_auto_assignment` boolean: The flag which shows whether Auto Assignment is enabled or not
      - `web_widget_script` string: Script used to load the website widget
      - `welcome_title` string, nullable: Welcome title to be displayed on the widget
      - `welcome_tagline` string, nullable: Welcome tagline to be displayed on the widget
      - `greeting_enabled` boolean: The flag which shows whether greeting is enabled
      - `greeting_message` string, nullable: A greeting message when the user starts the conversation
      - `channel_id` number: ID of the channel this inbox belongs to
      - `working_hours_enabled` boolean: The flag which shows whether working hours feature is enabled
      - `enable_email_collect` boolean: The flag to enable collecting email from contacts
      - `csat_survey_enabled` boolean: The flag to enable CSAT survey
      - `auto_assignment_config` object: Configuration settings for auto assignment
      - `out_of_office_message` string, nullable: Message to show when agents are out of office
      - `working_hours` object[]: Configuration for working hours of the inbox
        - `day_of_week` number: Day of the week (0-6, where 0 is Sunday)
        - `closed_all_day` boolean: Whether the inbox is closed for the entire day
        - `open_hour` number, nullable: Hour when inbox opens (0-23)
        - `open_minutes` number, nullable: Minutes of the hour when inbox opens (0-59)
        - `close_hour` number, nullable: Hour when inbox closes (0-23)
        - `close_minutes` number, nullable: Minutes of the hour when inbox closes (0-59)
        - `open_all_day` boolean: Whether the inbox is open for the entire day
      - `timezone` string: Timezone configuration for the inbox
      - `callback_webhook_url` string, nullable: Webhook URL for callbacks
      - `allow_messages_after_resolved` boolean: Whether to allow messages after a conversation is resolved
      - `lock_to_single_conversation` boolean: Whether to lock a contact to a single conversation
      - `sender_name_type` string: Type of sender name to display (e.g., friendly)
      - `business_name` string, nullable: Business name associated with the inbox
      - `hmac_mandatory` boolean: Whether HMAC verification is mandatory
      - `selected_feature_flags` string[], nullable: Selected feature flags for the inbox
      - `reply_time` string: Expected reply time
      - `messaging_service_sid` string, nullable: Messaging service SID for SMS providers
      - `phone_number` string, nullable: Phone number associated with the inbox
      - `medium` string: Medium of communication (e.g., sms, email)
      - `provider` string, nullable: Provider of the channel
    - `logo` PortalLogo
      - `id` integer: ID of the logo file
      - `portal_id` integer: ID of the portal this logo belongs to
      - `file_type` string: MIME type of the file
      - `account_id` integer: ID of the account
      - `file_url` string: URL to access the logo file
      - `blob_id` integer: ID of the blob
      - `filename` string: Name of the file
    - `meta` PortalMeta
      - `all_articles_count` integer: Total number of articles
      - `archived_articles_count` integer, nullable: Number of archived articles
      - `published_count` integer, nullable: Number of published articles
      - `draft_articles_count` integer, nullable: Number of draft articles
      - `categories_count` integer: Number of categories
      - `default_locale` string: Default locale for the portal

## Other responses

- `403`: Access denied

---

[API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)