Reference

Create or Update a Group

Create a new group or update an existing group's information, allowing you to manage company profiles and their attributes in your onboarding flows.

Create or Update a User

Synchronize user information to Userflow by creating new user profiles or updating existing ones, automatically merging data to keep your user database current.

List Users

Retrieve a paginated list of all users in your Userflow workspace, with options to filter, sort, and include related membership and group data. Use this to get an overview of your user base and manage access across your product.

Track an Event

Record custom user actions and behaviors to track engagement and enable personalized experiences based on what your customers do in your product.

Delete a Content Session

Permanently removes a content session and all its associated data including user progress and responses from your system. Use this when you need to clean up or reset user learning sessions.

Delete a Group

Permanently removes a group from your system along with all its associated data, while keeping individual members intact.

Delete a User

Permanently remove a user and all their associated data from your system, including attributes, memberships, and interaction history. This is useful when you need to clean up inactive accounts or comply with user removal requests.

Get a Content Object

Retrieves detailed information about a specific content object such as a flow, checklist, or launcher by its ID, including both draft and published versions. Use this when you need to view the current configuration or settings of a particular onboarding element.

Get a Content Version

Retrieve the complete details of a specific content version, including all questions for surveys or tasks for checklists. This helps you access historical versions or verify the exact content structure of your Userflow resources.

Get a Group

Retrieve detailed information about a specific group or company, including its attributes, creation date, and related data like members and users. This helps you access and verify company information stored in your Userflow account.

Get a User

Retrieve detailed information about a specific user including their profile attributes, creation date, and related data like group memberships. Use this to access user information for customer support, analytics, or account management purposes.

List Attribute Definitions

Retrieve all attribute definitions that track user and group data in your Userflow account, showing you what properties are being monitored across your application.

List Content

Retrieve all flows, checklists, and launchers from your Userflow account to see what onboarding and engagement content is available for your users.

List Content Sessions

Retrieve all recorded user interactions with your onboarding flows, checklists, and product tours to understand how users navigate and engage with your content.

List Content Versions

Retrieve the complete version history of your onboarding content, including surveys, checklists, and launchers, to track what changes have been made over time.

List Event Definitions

Retrieve all event definitions that Userflow is tracking to understand what user interactions and behaviors you're monitoring across your product.

List Groups

Retrieve all groups (companies) from your Userflow account with pagination and filtering options. Use this to access your complete list of customer groups for organization, analysis, or integration purposes.

Remove a User from a Group

Revokes a user's membership in a specific group, allowing you to manage who has access to group resources and communications. This is useful when users change roles, leave your organization, or should no longer participate in specific group activities.