- Category: customer support
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 14
- Triggers: 0
- Slug:
HELPDESK - Version: 20261101_00
Tools
List Agents
List Agents
List Canned Responses
List Canned Responses
List Custom Fields
List Custom Fields
List Email Domains
List Email Domains
Slug:
HELPDESK_LIST_EMAIL_DOMAINSLists all email domains configured for the HelpDesk account. Returns a comprehensive list of all email domains set up in the HelpDesk account, including domain names, verification status, DNS records, and configuration flags. Email domains allow you to send and receive tickets via custom email addresses. Use this action to: - Get domain IDs and names for use in other API operations - Check domain verification and setup status - View DNS configuration requirements - Audit which domains are actively being used for inbox No parameters required - returns all email domains accessible to the authenticated account.Output
List Licenses
List Licenses
Slug:
HELPDESK_LIST_LICENSESRetrieves all licenses (account configurations) for the authenticated HelpDesk account. A license represents a customer account and contains subscription information, global settings, default team/template assignments, and detected languages. Most accounts have one license. Use this action to: - Check account configuration and settings - Get account ID and metadata - View default team and template assignments - Inspect company settings and feature flags No parameters required - returns all licenses for the authenticated account.Output
List Reply Addresses
List Reply Addresses
Slug:
HELPDESK_LIST_REPLY_ADDRESSESLists all reply addresses configured in the HelpDesk account. Reply addresses are email addresses used to receive and respond to support tickets. Each reply address must be associated with a verified email domain and can be used as the “From” address when sending ticket responses to customers. Use this action to: - Get all available reply addresses and their verification status - Retrieve reply address IDs for use in other operations (e.g., creating mailboxes) - Check which email domains are being used for reply addresses - Audit reply address configuration across the account No parameters required - returns all reply addresses accessible to the authenticated account.Output
List Rules
List Rules
List Subscriptions
List Subscriptions
Slug:
HELPDESK_LIST_SUBSCRIPTIONSLists all billing subscriptions for the HelpDesk account, including active, expired, canceled, and future subscriptions. Subscriptions represent the currently selected plan (team or enterprise) and number of paid agent slots. Use this tool to retrieve subscription details including plan codes, pricing, billing cycles, trial periods, and subscription states. Both filter parameters are optional - omit them to retrieve all subscriptions.Input Parameters
Optional: Filter by subscription status. Options: ‘active’ (currently in use), ‘expired’ (past end date), ‘canceled’ (manually terminated), ‘future’ (not yet started), ‘pending’ (awaiting activation). Omit to include all states.
Optional: Filter by specific plan codes. Plan naming: ‘hd-{tier}{duration}m’ where tier is ‘team’ or ‘enterprise’, duration is billing period in months (1, 3, 6, 12, 24, or 36). Examples: ‘hd-team12m’ (Team plan, 12 months), ‘hd-enterprise6m’ (Enterprise plan, 6 months). Omit to include all plan types.
Output
List Teams
List Teams
Slug:
HELPDESK_LIST_TEAMSLists all teams in the HelpDesk account. Returns a comprehensive list of all teams configured in the HelpDesk account, including team IDs, names, settings, reply addresses, and integration configurations. Teams are organizational units that group agents and manage ticket routing. Use this action to: - Get team IDs for use in other API operations - Retrieve team names and configurations - Audit team settings and reply addresses - View team integration configurations No parameters required - returns all teams accessible to the authenticated account.Output
List Tickets
List Tickets
Slug:
HELPDESK_LIST_TICKETSLists tickets from a specified silo using cursor-based pagination, configurable page size, and sorting. The API defaults to open status, and this tool does not expose a status filter; totals default to zero when response headers are absent.Input Parameters
Silo/folder to list tickets from. Defaults to ‘tickets’.
Output
List Trusted Emails
List Trusted Emails
List Views
List Views
List Webhooks
List Webhooks
View Agent
View Agent
Slug:
HELPDESK_VIEW_AGENTRetrieves comprehensive details for a specific agent in the HelpDesk system. Returns complete agent information including profile details, role assignments, team memberships, status, settings, and signature configuration. Use this action when you need detailed information about a specific agent after obtaining their ID from the list_agents action.Input Parameters
The unique identifier (UUID format) of the agent to retrieve. Obtain agent IDs from the list_agents action.