Actions123
- Account Actions
- Account Agent Bot Actions
- Agent Actions
- Audit Log Actions
- Automation Rule Actions
- Canned Response Actions
- Contact Actions
- Contact Label Actions
- Conversation Actions
- Conversation Assignment Actions
- Custom Attribute Actions
- CSAT Survey Actions
- Custom Filter Actions
- Help Center Actions
- Inbox Actions
- Label Actions
- Conversation Label Actions
- Integration Actions
- Message Actions
- Profile Actions
- Report Actions
- Team Actions
- Webhook Actions
Help Center → Get Portal
AI-generatedSummary
Retrieves a help center portal by its ID using the selected API type.
Inputs
- portalId (required) — The ID of the help center portal to fetch. Required parameter with no default enforced at runtime despite UI default of 0.
- apiType — Select which API to use based on your role and use case. Defaults to 'application'. Three options: 'application' (agents/admins managing conversations, contacts, messages, teams, reports, account settings), 'client' (end-users/customers via web widgets, mobile apps, custom chat interfaces), or 'platform' (system admins managing multiple accounts, users, platform-level configurations for self-hosted/reseller).
Output shape
portal details matching the specified portalId and apiType. Exact field structure not declared in properties or source; returns the help center portal record.
The operation consumes the provided portalId and optional apiType, delegates to the relevant API module (ApplicationApi, ClientApi, or PlatformApi via the HelpCenter helper), and returns the corresponding portal information.