- Category: communication
- Auth: API_KEY, OAUTH2
- Composio-managed OAuth available? Yes
- Tools: 39
- Triggers: 0
- Slug:
ROAM - Version: 20261101_00
Tools
Add group members
Add group members
Add Reaction to Message
Add Reaction to Message
ROAM_ADD_REACTIONAdd an emoji reaction to a message in a chat. Use this action when you want to react to a message with an emoji in a Roam chat. The action requires the message ID, chat ID, reaction name, and timestamp. Required scope: chat:send_message or chat:write Response codes: 200=success, 400=bad request, 401=invalid credentials, 405=unsupported method, 500=internal errorInput Parameters
Output
Create Group
Create Group
ROAM_CREATE_GROUPCreate a group address that can be used for chat. Groups which specify an admin will operate in an “Admin only” management mode, where only admins may change settings. Otherwise, all members have that capability. Groups require at least one member or admin.Input Parameters
Output
Create Roam SCIM Group
Create Roam SCIM Group
ROAM_CREATE_ROAM_SCIM_GROUPTool to create a new group in your Roam organization using SCIM 2.0. Use when you need to provision a new group for managing user access and permissions via the SCIM 2.0 protocol. The displayName is required and must be 64 characters or less.Input Parameters
Output
Create Roam User
Create Roam User
ROAM_CREATE_USERCreate a new user in Roam via SCIM 2.0 protocol for automated user provisioning. Use when you need to add a new user to your Roam organization. The userName must match the primary email address exactly. The role defaults to ‘User’ but can be set to ‘Admin’ for administrative access. Note: Password attributes are not supported and will be ignored.Input Parameters
Output
Delete Roam Group
Delete Roam Group
Delete Roam User
Delete Roam User
Get Address Info
Get Address Info
ROAM_GET_ADDRESS_INFOGet information about a chat address, which is the name for any entity that may participate in a chat, such as a user, visitor, or bot. Use this action to retrieve details like display name, email, profile image, and other information about a specific chat address. Required scope: addr:infoInput Parameters
Output
Get chat history
Get chat history
ROAM_GET_CHAT_HISTORYLists messages in a chat, filtered by date range (after/before). The ordering of results depends on the filter specified: - If no parameters provided: returns most recent messages, sorted in reverse chronological order. - If ‘after’ is specified: results sorted in forward chronological order. In Personal mode, only chats where the authenticated user is a participant are accessible. Use this action to retrieve message history from a specific chat.Input Parameters
Output
Get meeting link
Get meeting link
Get Roam SCIM Resource Types
Get Roam SCIM Resource Types
Get SCIM service provider config
Get SCIM service provider config
ROAM_GET_ROAM_SCIM_CONFIGTool to retrieve Roam’s SCIM service provider configuration. Use when you need to discover Roam’s SCIM API capabilities including supported authentication schemes, bulk operations, filtering, and other service provider features. This endpoint returns the SCIM 2.0 ServiceProviderConfig resource which describes the supported features.Output
Get SCIM schema
Get SCIM schema
ROAM_GET_SCIM_SCHEMARetrieves the definition of a specific SCIM 2.0 schema by its unique identifier (URN). This endpoint returns the complete schema definition including all attributes, their types, mutability, and other properties. Common schemas include: - urn:ietf:params:scim:schemas:core:2.0:User (User resource schema) - urn:ietf:params:scim:schemas:core:2.0:Group (Group resource schema) - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User (Enterprise User extension) Use this to understand the structure of SCIM resources and what attributes are available.Input Parameters
Output
Get user by ID (SCIM)
Get user by ID (SCIM)
ROAM_GET_SCIM_USERTool to retrieve a single user by their Roam Person ID using SCIM 2.0 protocol. Use when you need to get detailed information about a specific user including their name, email, active status, and role in Roam. The user ID is the SCIM user ID (Person ID) that can be obtained from user list or user creation operations. Endpoint: GET /scim/v2/Users/{id}Input Parameters
Output
Test API Connectivity
Test API Connectivity
Get token info
Get token info
Get user info
Get user info
ROAM_GET_USER_INFOGet detailed information about a single user in your Roam workspace. Requires user:read scope. Additional scopes (user:read.email, user:read.status) needed for expanded fields.Input Parameters
Output
List Roam Chats
List Roam Chats
ROAM_LIST_CHATSLists all accessible chats, which consist of all DMs, MultiDMs, and Channels that your bot has been added to, in addition to all public channels. Supports pagination via cursor and limiting the number of results. Use this action to discover available chats before performing operations on them.Input Parameters
Output
List group members
List group members
ROAM_LIST_GROUP_MEMBERSList members in a group in your Roam workspace. Use this tool when: - You need to see all members of a specific group - You want to check who has access to a group - You need to paginate through large groups Access conditions: - The group must be public in the user’s Roam, OR - The app must be a member of the group Required scope: groups:read Returns a list of user IDs with pagination support via nextCursor.Input Parameters
Output
List SCIM Groups
List SCIM Groups
ROAM_LIST_GROUPSReturns a paginated list of groups in your Roam organization via SCIM 2.0. Use when you need to retrieve all groups in your Roam organization using the SCIM protocol. Supports pagination using startIndex and count parameters. Note: The filter parameter is currently ignored for the Groups endpoint.Input Parameters
Output
List Roam Lobbies
List Roam Lobbies
List Roam Meetings
List Roam Meetings
ROAM_LIST_MEETINGSLists all meetings in your home Roam, filtered by date range. Supports pagination via cursor and limiting the number of results. Returns meeting details including meeting ID, room, time, and participants. Use this action to discover available meetings in your Roam workspace.Input Parameters
Output
List Roam Recordings
List Roam Recordings
List users (SCIM)
List users (SCIM)
ROAM_LIST_ROAM_SCIM_USERSTool to list users in your Roam organization using SCIM 2.0 protocol. Use when you need to retrieve a paginated list of users in your Roam workspace via the SCIM 2.0 API for identity provider integration. Supports pagination via startIndex and count parameters, as well as filtering by user attributes using SCIM filter expressions. Endpoint: GET /scim/v2/UsersInput Parameters
Output
List SCIM Schemas
List SCIM Schemas
List Roam Transcripts
List Roam Transcripts
ROAM_LIST_TRANSCRIPTSLists all transcripts in your Roam workspace, filtered by date range. Supports pagination via cursor and limiting the number of results. Returns transcript metadata (id, meetingId, start, end, participants) without full content. Use this action to discover available transcripts before retrieving detailed content.Input Parameters
Output
List User Audit Log
List User Audit Log
ROAM_LIST_USER_AUDIT_LOGTool to get a list of user audit log entries for the account. Use when you need to retrieve audit logs for compliance and security monitoring purposes. This action requires the ‘userauditlog:read’ scope and organization-level access. Required parameter: date (format: YYYY-MM-DD) Optional: limit for pagination, cursor for paginating through results.Input Parameters
Output
List Users
List Users
ROAM_LIST_USERSTool to list all users in the Roam workspace. Use when you need to retrieve a list of users with optional pagination and expanded fields like status. Required scope: user:read (add user:read.email for emails, user:read.status for presence status).Input Parameters
Output
Lookup user by email
Lookup user by email
Patch a group
Patch a group
ROAM_PATCH_GROUPPartially updates a group using SCIM 2.0 protocol. Use this action to add or remove members from a group, or replace the group’s display name. The PATCH operation supports ‘add’, ‘remove’, and ‘replace’ operations on group attributes. Example usage: - Add members: op=‘add’, path=‘members’, value=[{‘value’: ‘686562’, ‘ref’: ‘Users/686562’}] - Remove members: op=‘remove’, path=‘members’, value=[{‘value’: ‘686562’}] - Replace displayName: op=‘replace’, path=‘displayName’, value=‘New Group Name’Input Parameters
Output
Patch user (SCIM)
Patch user (SCIM)
ROAM_PATCH_USERPartially updates a user using SCIM 2.0 protocol. Use when you need to modify specific attributes of an existing user without replacing the entire resource. Currently, Roam only supports the ‘replace’ operation on the ‘active’ attribute, which allows archiving or reactivating a user. Other operations like ‘add’ or account ‘remove’ are not supported, and ‘replace’ on attributes other than ‘active’ will fail. Example usage: - Deactivate/archive user: op=‘replace’, path=‘active’, value=false - Reactivate user: op=‘replace’, path=‘active’, value=true Endpoint: PATCH /scim/v2/Users/{id}Input Parameters
Output
Post message to chat
Post message to chat
ROAM_POST_CHATPost a message to a Roam group using plain markdown text or rich Block Kit layouts with headers, sections, buttons, and more. Use syntax <@USER_ID> for mentions.Input Parameters
Output
Remove group members
Remove group members
ROAM_REMOVE_GROUP_MEMBERSTool to remove one or more members from a group in your Roam workspace. Use when you need to remove users from a specific group. Note: The group must be public in the user’s Roam, or the app must be a member of the group to remove members. Admin role members cannot be removed yet.Input Parameters
Output
Replace Roam SCIM Group
Replace Roam SCIM Group
ROAM_REPLACE_GROUPFully replaces a group’s attributes using SCIM 2.0 protocol. Use when you need to completely replace all attributes of an existing group, including its display name and member list. This is a full update (PUT), not a partial update (PATCH). Note: Unlike PATCH which only modifies specified attributes, PUT requires sending all desired attributes. Any attributes not included will be reset to default values (e.g., members list will be replaced entirely).Input Parameters
Output
Replace Roam User
Replace Roam User
ROAM_REPLACE_USERFully replaces a Roam user via SCIM 2.0 PUT. The request defaults the user to active and the role to User, so supply the desired status and role when replacing an existing account.Input Parameters
Output
Send message to group
Send message to group
ROAM_SEND_MESSAGESends the given message to the specified recipients. At this time, we only support sending to a single group recipient. You can obtain the group ID on the Group Settings page.Input Parameters
Output
Send Typing Indicator
Send Typing Indicator
ROAM_SEND_TYPINGTool to notify other chat participants that you are typing. Use when you want to show a typing indicator to one or more users in a chat conversation. This is typically used before sending a message to let recipients know you’re composing a response.Input Parameters
Output
Update a meeting link
Update a meeting link
ROAM_UPDATE_MEETING_LINKUpdate settings for an existing meeting link in Roam. Use this action when you need to modify the name, start time, or end time of an existing meeting link. The meeting link ID is required to identify which meeting to update. Note: The host field cannot be updated; if provided, it must match the existing value. Returns 204 No Content on success.Input Parameters
Output
Upload File to Roam
Upload File to Roam
ROAM_UPLOAD_ITEMUpload a file to Roam so it can be sent as a chat attachment. Use when you need to upload a file, image, or document to Roam before sending it in a chat message. Returns an item ID that can be used with the chat.post endpoint. Supported file types: - Images (image/png, image/jpeg, image/gif, image/webp): Displayed inline with preview thumbnail - Other files (application/octet-stream): Download link only Maximum file size: 10 MB