Customer Data
Get Customer From Id Retrieves comprehensive account information for a specific customer using their unique identifier.
Search For Customers Finds customers by name, segment, region, or other criteria. Useful for locating specific accounts or groups of similar customers.
Get Scoped Customers Returns customers within a specific scope β such as your assigned accounts, team accounts, or all accounts β based on your access permissions.
Get Matching Customers Searches for customers matching specific filters such as renewal dates, revenue ranges, engagement signals, or custom fields.
Get Customer Contacts Shows the key people at a customer account, including contacts and decision-makers you should know about.
Get Customer User Looks up a specific user at a customer account by name to see their activity and engagement.
Get Users Of Type For Customer Lists users at a customer account by their engagement level: Active, Power, Zombie, Inactive, or Influencer.
Get Organization Customer Custom Fields Shows custom data fields configured for tracking customer-specific information unique to your business.
get_customer_notes Returns a list of internal notes for a customer account, sorted by most recently updated. Typically used for internal comments or observations made by team members.
Metrics & Health
Get Account Metric Values Retrieves key performance metrics for a customer account, such as usage statistics, adoption rates, and health scores.
Get Customer Metric Values Fetches specific metric values for a customer to understand their product usage and engagement trends.
Get Organization Metric Descriptions Provides descriptions and definitions for all available customer metrics in your organisation.
Get Customer Renewal Likelihoods Shows predicted renewal probability for a customer based on engagement patterns and historical data.
Get Aggregate Renewals Data Provides aggregated data about customer renewals to help understand renewal trends and forecasts.
Get Customer Model Outputs History Displays historical predictions and model outputs for a customer over time to track how their health has evolved.
Summarize Numbers Converts large numbers or data sets into easy-to-understand summaries and comparisons.
Signals & Actions
Get Detected Signals Shows automatically detected signals for a customer, including potential risks, concerns, or growth opportunities that need attention.
Close Detected Signal Marks a detected signal as resolved when the issue has been addressed or is no longer relevant.
Get Organization Signal Configuration Retrieves your organisation's signal categories and definitions, showing how different types of risks and opportunities are classified.
Create Signal Detection Job Summary Records the results of an automated signal detection analysis for tracking and review.
Get Agent Account Actions Lists all recommended actions for a customer, showing what needs to be done, what's completed, and what's been dismissed.
Get Agent Account Actions Origin Groups Retrieves groups of related actions created for the same reason or analysis, helping you see the history of recommendations.
Create Agent Account Actions Creates recommended actions for a customer account, such as follow-up emails or specific next steps to improve the relationship.
Create Actions Workflow Creates new agent account actions as part of an automated workflow.
Patch Agent Account Action Updates the status of a recommended action, such as marking it complete, dismissed, or modifying its details.
Meetings, Emails & Communications
Get Recent Customer Meetings Lists recent meetings with a customer, including summaries, next steps, and optionally full transcripts.
Get Customer Meeting Transcript Retrieves the complete transcript of a specific customer meeting for detailed review.
Get Recent Customer Emails Accesses recent email exchanges with a customer to review communication history and context.
Get Recent Customer Support Tickets Shows recent support conversations with a customer, helping you understand current issues and support history.
Get Customer Support Ticket By Id Retrieves the complete details of a specific support ticket, including description, contact information, and resolution status.
Get Recent Customer Instant Messages Pulls recent chat and instant message conversations to track real-time customer interactions.
People & Contacts
Search For People At Domain Finds people working at a company using their domain name, with optional filters for job title and seniority level.
Search Person By Fields Searches for individuals by name, company, job title, or aliases to find the right contact.
Get User Description Shows information about a team member, including their role, permissions, direct reports, and account responsibilities.
Notifications & Slack
Search Slack Users Or Channels Searches for Slack users or channels by name to find the right destination for a notification.
Send Notification Sends a message directly to a team member via Slack to alert them about important information.
Send Notification To Channel Posts a message to a Slack channel to share updates with your team.
Briefs
Save Brief Saves a research brief or summary to the system for future reference and access.
Organisation Settings
Get Organization Information Provides background information about your organisation, products, and competitive landscape for context.
Get Organization Current Fiscal Calendar Shows your organisation's fiscal calendar to help interpret time-based queries like "this quarter" or "next year".
Get Organization Signal Configuration Retrieves your organisation's signal categories and definitions.
Get Organization Metric Descriptions Provides descriptions and definitions for all available customer metrics.
Get Organization Roles Lists the different roles users can have in your organisation, such as CSM, Account Executive, or Support Engineer.
Get Organization Product User Type Definitions Explains how your organisation defines Active Users and Power Users for each product.
Scheduling & Automation
Enqueue Job Schedules an automated task to run at a specific time in the future.
Report Bot Job Status Reports the completion status of an automated task and optionally schedules the next run.
Get Prompt Payload Variables Retrieves the information needed to properly schedule and configure automated tasks.
Reschedule Execution Provides guidance on the policy for rescheduling an execution.
Utilities
Get Current Date Returns today's date for use in calculations and time-based queries.
Get Time Period Converts time period descriptions (like "this quarter" or "last month") into specific date ranges based on your fiscal calendar.
Get Resource Retrieves reference documentation or resources that provide helpful context and information.
List Resources Lists all available reference resources and documentation that can be accessed for additional context.