> ## Documentation Index > Fetch the complete documentation index at: https://docs.airys.chat/llms.txt > Use this file to discover all available pages before exploring further. # Listar todos os portals em an conta > Obter detalhes de portais em uma conta ## OpenAPI ````yaml /pt-br/swagger/tag_groups/application_swagger.json get /api/v1/accounts/{account_id}/portals openapi: 3.1.0 info: title: Chatwoot description: Esta é a documentação da API para o servidor Chatwoot. version: 1.1.0 termsOfService: https://www.chatwoot.com/terms-of-service/ contact: email: hello@chatwoot.com license: name: MIT License url: https://opensource.org/licenses/MIT servers: - url: https://airys.chat/ security: [] tags: - name: AgentBots de Conta description: Agent Bots específicos da conta - name: Agentes description: APIs de gerenciamento de agentes - name: Respostas Prontas description: Respostas predefinidas para consultas comuns - name: Contatos description: APIs de gerenciamento de contatos - name: Rótulos de Contato description: Gerenciar rótulos de contato - name: Atribuições de Conversa description: Gerenciar atribuições de conversas - name: Rótulos de Conversa description: Gerenciar rótulos de conversas - name: Conversas description: APIs de gerenciamento de conversas - name: Atributos Personalizados description: Campos personalizados para contatos e conversas - name: Filtros Personalizados description: Filtros salvos para conversas - name: Caixas de Entrada description: Configuração de canais de comunicação - name: Integrações description: Integrações de terceiros - name: Rótulos description: APIs de gerenciamento de rótulos da conta - name: Mensagens description: APIs de gerenciamento de mensagens - name: Perfil description: APIs de perfil de usuário - name: Relatórios description: APIs de análise e relatórios - name: Equipes description: APIs de gerenciamento de equipe - name: Webhooks description: Webhooks de notificação de eventos - name: Regra de Automação description: Regras de automação de fluxo de trabalho - name: Central de Ajuda description: Gerenciamento da base de conhecimento paths: /api/v1/accounts/{account_id}/portals: parameters: - $ref: '#/components/parameters/account_id' get: tags: - Central de Ajuda summary: Listar todos os portals em an conta description: Obter detalhes de portais em uma conta operationId: get-portal parameters: - $ref: '#/components/parameters/account_id' responses: '200': description: Sucesso content: application/json: schema: $ref: '#/components/schemas/portal' example: payload: - id: 4 color: '#1F93FF' custom_domain: chatwoot.help header_text: Handbook homepage_link: https://www.chatwoot.com name: Handbook page_title: Handbook slug: handbook archived: false account_id: 1 config: allowed_locales: - code: en articles_count: 32 categories_count: 9 inbox: id: 37 avatar_url: https://example.com/avatar.png channel_id: 1 name: Chatwoot channel_type: Channel::WebWidget greeting_enabled: true widget_color: '#1F93FF' website_url: chatwoot.com logo: id: 19399916 portal_id: 4 file_type: image/png account_id: 1 file_url: https://example.com/logo.png blob_id: 21239614 filename: square.png meta: all_articles_count: 0 categories_count: 9 default_locale: en '403': description: Acesso negado content: application/json: schema: $ref: '#/components/schemas/bad_request_error' security: - userApiKey: [] components: parameters: account_id: in: path name: account_id schema: type: integer required: true description: O ID numérico da conta schemas: portal: type: object properties: payload: type: array items: $ref: '#/components/schemas/portal_item' bad_request_error: title: data type: object properties: description: type: string errors: type: array items: $ref: '#/components/schemas/request_error' portal_item: type: object properties: id: type: integer description: O ID do portal archived: type: boolean description: Se o portal está arquivado color: type: string description: O código de cores para o portal config: $ref: '#/components/schemas/portal_config' custom_domain: type: string description: Domínio personalizado para o portal header_text: type: string description: O texto do cabeçalho para o portal homepage_link: type: string description: Link da página inicial para o portal name: type: string description: Nome do portal slug: type: string description: Slug de URL para o portal page_title: type: string description: Título da página para o portal account_id: type: integer description: ID da conta a qual o portal pertence inbox: $ref: '#/components/schemas/inbox' logo: $ref: '#/components/schemas/portal_logo' meta: $ref: '#/components/schemas/portal_meta' request_error: type: object properties: field: type: string message: type: string code: type: string portal_config: type: object description: Configurações para o portal properties: allowed_locales: type: array description: Lista de localidades (locales) permitidas para o portal items: type: object properties: code: type: string description: O código do idioma articles_count: type: integer description: Número de artigos nesta localidade categories_count: type: integer description: Número de categorias nesta localidade inbox: type: object properties: id: type: number description: ID da caixa de entrada name: type: string description: O nome da caixa de entrada website_url: type: string description: URL do site channel_type: type: string description: O tipo da caixa de entrada avatar_url: type: string description: A imagem de avatar da caixa de entrada widget_color: type: string description: Cor do widget usada para personalização do widget website_token: type: string description: Token do site enable_auto_assignment: type: boolean description: >- A sinalização que mostra se a Atribuição Automática está habilitada ou não web_widget_script: type: string description: Script usado para carregar o widget do site welcome_title: type: - string - 'null' description: Título de boas-vindas a ser exibido no widget welcome_tagline: type: - string - 'null' description: Slogan de boas-vindas a ser exibido no widget greeting_enabled: type: boolean description: A sinalização que mostra se a saudação está habilitada greeting_message: type: - string - 'null' description: Uma mensagem de saudação quando o usuário inicia a conversa channel_id: type: number description: ID do canal ao qual esta caixa de entrada pertence working_hours_enabled: type: boolean description: >- A sinalização que mostra se o recurso de horário comercial está ativado enable_email_collect: type: boolean description: A sinalização para permitir a coleta de e-mail de contatos csat_survey_enabled: type: boolean description: A sinalização para habilitar a pesquisa CSAT auto_assignment_config: type: object description: Configurações para atribuição automática out_of_office_message: type: - string - 'null' description: Mensagem para mostrar quando os agentes estiverem fora do escritório working_hours: type: array description: Configuração para o horário comercial da caixa de entrada items: type: object properties: day_of_week: type: number description: Dia da semana (0-6, onde 0 é domingo) closed_all_day: type: boolean description: Se a caixa de entrada está fechada o dia inteiro open_hour: type: - number - 'null' description: Hora de abertura da caixa de entrada (0-23) open_minutes: type: - number - 'null' description: Minutos da hora em que a caixa de entrada abre (0-59) close_hour: type: - number - 'null' description: Hora de fechamento da caixa de entrada (0-23) close_minutes: type: - number - 'null' description: Minutos da hora em que a caixa de entrada fecha (0-59) open_all_day: type: boolean description: Se a caixa de entrada está aberta o dia inteiro timezone: type: string description: Configuração de fuso horário para a caixa de entrada callback_webhook_url: type: - string - 'null' description: URL do webhook para callbacks allow_messages_after_resolved: type: boolean description: Se deve permitir mensagens após uma conversa ser resolvida lock_to_single_conversation: type: boolean description: Se deve bloquear um contato a uma única conversa sender_name_type: type: string description: Tipo de nome do remetente a ser exibido (ex., amigável) business_name: type: - string - 'null' description: Nome da empresa associada à caixa de entrada hmac_mandatory: type: boolean description: Se a verificação HMAC é obrigatória selected_feature_flags: type: - array - 'null' description: >- Sinalizadores de recursos (feature flags) selecionados para a caixa de entrada items: type: string reply_time: type: string description: Tempo de resposta esperado messaging_service_sid: type: - string - 'null' description: SID do serviço de mensagens para provedores de SMS phone_number: type: - string - 'null' description: Número de telefone associado à caixa de entrada medium: type: string description: Meio de comunicação (ex., sms, email) provider: type: - string - 'null' description: Provedor do canal portal_logo: type: object properties: id: type: integer description: ID do arquivo de logotipo portal_id: type: integer description: ID do portal a que este logotipo pertence file_type: type: string description: Tipo MIME do arquivo account_id: type: integer description: ID da conta file_url: type: string description: URL para acessar o arquivo de logotipo blob_id: type: integer description: ID do blob filename: type: string description: Nome do arquivo portal_meta: type: object properties: all_articles_count: type: integer description: Número total de artigos archived_articles_count: type: - integer - 'null' description: Número de artigos arquivados published_count: type: - integer - 'null' description: Número de artigos publicados draft_articles_count: type: - integer - 'null' description: Número de artigos de rascunho categories_count: type: integer description: Número de categorias default_locale: type: string description: Localidade padrão para o portal securitySchemes: userApiKey: type: apiKey in: header name: api_access_token description: >- Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário. ````