Reference

Get Address Info

Retrieve detailed information about a chat participant such as their display name, email, and profile image. This helps you verify contact details and understand who you're communicating with in your chat system.

List User Audit Log

Retrieve a chronological list of user activities and account changes from your organization's audit logs. This helps you track who did what and when for security monitoring and compliance verification.

Get token info

Retrieves details about your Roam access token, including your bot's chat address, granted permissions, and workspace information to verify your integration setup.

List Roam Chats

Retrieve all your accessible chats including direct messages, group chats, and channels to see what conversations your bot can interact with.

Get chat history

Retrieves messages from a specific chat with optional date filtering to help you access conversation history when you need to review past discussions or find specific information shared in chats.

Post message to chat

Send messages to chats, groups, or individual users with support for rich formatting, mentions, and interactive elements like buttons and sections.

Get Roam SCIM Resource Types

Retrieves the complete list of resource types that can be managed through Roam's system, helping you understand what entities you can create, update, or manage via automation.

Get SCIM schema

Retrieves the complete definition of a SCIM schema to understand what user and group attributes are available in your communication platform. This helps you verify data structure compatibility before syncing team information.

Get SCIM service provider config

Retrieves Roam's SCIM service provider configuration to understand what features and authentication methods are available for integrating your systems. This helps you determine compatibility and plan your account management workflows.

List SCIM Schemas

Retrieve all available SCIM schemas supported by Roam to understand what user and group data structures you can work with. This helps you discover the standard and custom fields available for managing your team members and organizational groups.

Upload File to Roam

Upload files, images, or documents to Roam so they can be shared in chat messages and conversations. This generates a unique item ID that you can attach to your chat posts.

List SCIM Groups

Retrieve a complete list of all groups in your Roam organization to manage team structures and permissions. This helps you see who belongs to which groups and maintain organized team hierarchies.

Add group members

Add new members or admins to a Roam group in bulk, helping you manage group access and delegate responsibilities without manually inviting each person individually.

Create Group

Create a group address for team chat and communication. This establishes a dedicated space where members can collaborate, with optional admin controls to manage group settings and membership.

Create Roam SCIM Group

Creates a new group in your Roam organization to organize users and manage access permissions across your team or projects. This allows you to set up structured team hierarchies and control who can access specific resources.

Delete Roam Group

Archive a group in Roam while preserving all historical data for compliance and audit purposes. Use this to clean up inactive groups without permanently deleting team communication records.

List group members

Retrieve all members in a specific group within your Roam workspace to see who has access and manage group participation. This helps you track team composition and collaboration within groups.

Patch a group

Update group settings and membership by adding, removing, or changing members and group names in your organization.

Remove group members

Remove one or more members from a group in your Roam workspace to manage group composition and access. Useful when team members leave, change roles, or should no longer participate in specific group conversations.

Replace Roam SCIM Group

Completely replaces all attributes of a group including its name and membership list, ensuring the group configuration matches exactly what you specify. Use this when you need to enforce a new group structure rather than making incremental changes.

Get meeting link

Retrieve the details and URL of a specific meeting link by its ID, allowing you to share or reference meeting information quickly. This is useful when you need to access previously created meeting links without manually searching through your records.

List Roam Lobbies

Retrieve all active lobbies from your Roam account to see what communication channels are available for your business.

List Roam Meetings

Retrieve all meetings in your Roam workspace with flexible filtering by date range and pagination options. Use this to get a complete view of scheduled meetings and their details across your team.

Update a meeting link

Modify an existing meeting link's details such as name, start time, or end time without creating a new link. This helps you adjust meeting schedules or details on the fly without disrupting attendee access.

Send message to group

Send a message to a specific group in Roam to communicate with team members or audience segments. This helps you broadcast updates, announcements, or information to multiple people at once.

Add Reaction to Message

Add an emoji reaction to a message in Roam chat to quickly express sentiment or acknowledgment without typing a full response. This helps teams communicate more efficiently and keeps conversations organized with visual cues.

Send Typing Indicator

Notifies chat participants that you're composing a message, displaying a typing indicator in the conversation. Use this to provide real-time feedback and improve communication clarity in group chats or one-on-one conversations.

List Roam Recordings

Retrieve all recordings from your Roam system with optional filtering by date range and pagination support to manage large collections of recordings efficiently.

Test API Connectivity

Verify that your Roam API connection is working properly and your authentication credentials are valid. This ensures your integration is set up correctly before running other operations.

List Roam Transcripts

Retrieve a list of all transcripts from your Roam workspace with filtering by date range and pagination support to discover and manage available meeting recordings.

Create Roam User

Automatically add new team members to your Roam workspace with their email and role assignments. This streamlines employee onboarding by eliminating manual user setup in your communication platform.

List Users

Retrieve all users in your Roam workspace to see who has access and their current status. Useful for managing team members and understanding workspace participation.

Delete Roam User

Remove a user from your Roam workspace while keeping their data intact for records and compliance. This preserves communication history and maintains organizational audit trails.

Get user by ID (SCIM)

Retrieve detailed information about a specific user in Roam by their ID, including their name, email, status, and role. Use this to quickly access individual user profiles or verify user details in your workspace.

Get user info

Retrieve comprehensive details about a specific user in your Roam workspace, including their profile information and account status. Use this to access user data for verification, account management, or personalization purposes.

List users (SCIM)

Retrieve a list of users in your Roam organization to manage team members and access permissions. This is useful for syncing your team directory with other business tools or auditing who has access to your workspace.

Lookup user by email

Find a user's profile information in your Roam workspace by searching with their email address, retrieving details like their ID and name for further actions.

Patch user (SCIM)

Update specific user attributes in your Roam workspace, primarily to activate or archive user accounts without affecting other profile information.

Replace Roam User

Completely updates all attributes for a user in Roam by replacing their entire profile with new information. Use this when you need to make comprehensive changes to a user's account details at once.