Skip to main content
Roam logo
  • Category: communication
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 39
  • Triggers: 0
  • Slug: ROAM
  • Version: 20261101_00

Tools

Slug: ROAM_ADD_GROUP_MEMBERSAdd members and/or admins to an existing Roam group, including promoting existing members; a 204 response yields a success flag. Adding members requires a public group or app membership, while adding admins requires the app to be a group admin.

Input Parameters

string
required
The unique identifier of the group to add members to
array
List of user IDs to add as admins to the group
array
List of user IDs to add as members to the group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 error

Input Parameters

string
required
The unique ID of the chat containing the message. This is the chat identifier starting with C-.
string
required
The name of the reaction/emoji to add. Common values include ‘smile’, ‘thumbsup’, ‘heart’, etc.
integer
required
Unix timestamp (in seconds) when the reaction was added.
string
required
The unique ID of the message to add the reaction to. This is the UUID of the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the group (max 64 characters).
array
List of admin email addresses or IDs. Groups with admins operate in ‘Admin only’ management mode.
array
List of member email addresses or IDs to add to the group.
boolean
Whether the group is private. Defaults to false.
string
The description of the group (max 1024 characters).
boolean
Whether threads are enforced in the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional list of members to add to the group. Each member should be a dict with a ‘value’ field containing a Roam Person ID.
array
SCIM schema array. Defaults to [‘urn:ietf:params:scim:schemas:core:2.0:Group’]
string
required
The display name of the group. Maximum 64 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Name object containing the user’s given name and family name.
string ("User" | "Admin")
User role in Roam organization.
boolean
Whether the user account is active. Set to false to archive/deprovision the user. Defaults to true.
array
required
List of email addresses for the user. The primary email must match userName.
array
SCIM schemas to include in the request. Defaults to standard User schema.
string
required
Username for the user. Must be the user’s email address and must exactly match the primary email value.
string
External identifier for correlation with IdP records.
string
Full name of the user. Note: Roam auto-generates this from givenName + familyName, so this value may be ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_DELETE_GROUPArchive a group in Roam using SCIM 2.0. On a successful 204 response, returns a success flag and status code.

Input Parameters

string
required
The unique identifier of the group to archive. This is the SCIM group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_DELETE_USERArchive a Roam user through SCIM 2.0, deprovisioning the user while preserving their data. On a successful 204 response, returns a success flag and status code.

Input Parameters

string
required
The unique identifier of the user to archive. This is the SCIM user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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:info

Input Parameters

string
required
The chat address to fetch information for. This is a unique identifier for entities that may participate in a chat, such as users, visitors, or bots. Format: U-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The chat address (UUID) to fetch messages from.
string
The datetime to begin listing messages (UTC). Format: YYYY-MM-DD or RFC-3339 datetime. If specified, results are sorted in forward chronological order.
integer
Number of messages to return. Default is 10, maximum is 200.
string
The datetime until which to list messages (UTC). Format: YYYY-MM-DD or RFC-3339 datetime. Defaults to ‘now’ if not specified.
string
Opaque pagination cursor from a previous response’s nextCursor. Do not construct cursors manually.
integer
Read replies of the message with this timestamp. Use to fetch replies to a specific message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_GET_RESOURCE_TYPESReturns the list of SCIM 2.0 resource types supported by Roam. Use this action to discover what resource types are available in the Roam SCIM API. Currently returns User and Group resource types. This endpoint requires no parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the SCIM schema to retrieve. Common values: ‘urn:ietf:params:scim:schemas:core:2.0:User’ for User schema, ‘urn:ietf:params:scim:schemas:core:2.0:Group’ for Group schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user (Roam Person ID). This is the SCIM user ID returned by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_GET_TESTTest endpoint for API connectivity. Use this endpoint to verify that the Roam API is accessible and authentication is working correctly. Returns a confirmation message on successful connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_GET_TOKEN_INFORetrieves information about the current Roam access token, including the returned principal ID, granted scopes, and associated workspace information when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The User ID to look up. Format: U-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
string
Comma-separated list of additional fields to include. Supported values: ‘status’, ‘available’. Requires corresponding scopes (user:read.status).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of chats to return (1-100, default: 10)
string
Pagination cursor from previous response to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the group whose members to list
integer
Number of members to return. Minimum: 1, Maximum: 100, Default: 10
string
Pagination cursor from a previous response to get the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The number of resources to return in a single page. Default is 100.
string
A SCIM filter expression. Currently ignored for Groups endpoint.
integer
The 1-based index of the first result in the current page of results. Default is 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_LIST_LOBBIESLists active lobbies in your Roam account. Returns all lobby configurations with their IDs, display names, URLs, and active status. Use this action to discover available lobbies before performing operations on them.

Input Parameters

string
Filter for lobbies with a specific handle (first path segment of the URL).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter for meetings that started after this date/time (UTC). Format: YYYY-MM-DD or RFC-3339 datetime.
integer
Number of meetings to return per response.
string
Filter for meetings that started before this date/time (UTC). Format: YYYY-MM-DD or RFC-3339 datetime. Defaults to now if not specified.
string
Opaque cursor from a previous response to fetch the next page of results. Do not construct cursors manually.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_LIST_RECORDINGSLists accessible recordings in Roam, with optional date-range filtering and pagination. Organization clients without roam-wide meeting access cannot use this legacy recording list.

Input Parameters

string
The datetime to begin listing recordings (YYYY-MM-DD or RFC-3339 format).
integer
The number of recordings to return per response. Default is 10, max 100.
string
The datetime until which to list recordings (YYYY-MM-DD or RFC-3339 format).
string
Opaque pagination cursor from a previous response’s nextCursor field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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/Users

Input Parameters

integer
The maximum number of users to return per page. Use this for pagination to control page size.
string
A SCIM filter expression to narrow down results. For example, ‘userName eq “alice@example.com”’ to find a specific user. Supports filtering by userName, name, emails, and active attributes.
integer
The 1-based index of the first result to return. Use this for pagination to retrieve subsequent pages of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_LIST_SCHEMASTool to list all SCIM 2.0 schemas supported by Roam. Use when you need to discover available SCIM resource schemas. Returns the core User and Group schemas plus Roam’s custom role extension schemas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter for transcripts that started after this date/time (UTC). Format: YYYY-MM-DD or RFC-3339 datetime.
integer
Number of transcripts to return.
string
Filter for transcripts that started before this date/time (UTC). Format: YYYY-MM-DD or RFC-3339 datetime.
string
Opaque cursor from a previous response to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Date to retrieve audit logs for. Format: YYYY-MM-DD.
integer
Number of audit log entries to return. Must be between 1 and 100.
string
Pagination cursor from a previous response to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of users to return. Must be between 1 and 100.
string
Pagination cursor from a previous response to fetch the next page of results.
string
Comma-separated list of additional fields to include. Supported: ‘status’ (requires user:read.status scope).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ROAM_LOOKUP_USERLook up a user in your Roam workspace by their email address. Use when you need to find a user’s details including their ID, name, and profile information. Required scopes: user:read and user:read.email.

Input Parameters

string
required
The email address of the user to look up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the group (Roam AddressID).
array
required
Array of SCIM PATCH operations to perform on the group. Use ‘add’ or ‘remove’ for members, ‘replace’ for displayName.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user (Roam Person ID) to update.
array
required
Array of SCIM PATCH operations to perform on the user. Note: Roam only supports ‘replace’ operation on the ‘active’ attribute (to archive or reactivate a user).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A Tagged ID (chat, group, or address). Can also be an array of user addresses to create a Multi-DM.
boolean
If true, post is performed synchronously and timestamp returned.
string
Markdown-formatted text content. Cannot be combined with blocks. Either text or blocks is required.
string
Colored vertical strip. Values: good, warning, danger, or hex (e.g., #5B3FD9). Only used with blocks.
array
Array of Item IDs (UUIDs) to attach. Cannot be combined with blocks.
array
Array of Block Kit block objects (header, section, context, divider, actions). Cannot be combined with text. Max 10 blocks, 8,000 bytes.
boolean
Defaults to true. Set false to disable markdown interpretation.
string
External identifier for threading messages. Max 64 characters. Mutually exclusive with thread_timestamp.
integer
Reply to a specific thread. Mutually exclusive with thread_key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The group address (TaggedUUID format, e.g., G-13137f22-926c-4323-baf7-9c953bdccf99)
array
required
List of member IDs to remove (TaggedUUID format, e.g., U-a86af3af-7d0b-4d4c-8392-85ffdf30881e)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the group (Roam AddressID) to replace.
array
Optional list of members to replace the current group members. Each member should be a dict with a ‘value’ field containing a Roam Person ID. If not provided, existing members will be removed.
array
SCIM schema array. Defaults to [‘urn:ietf:params:scim:schemas:core:2.0:Group’]
string
required
The display name of the group. Maximum 64 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user to replace. This is the SCIM user ID.
object
required
Name object containing the user’s given name and family name.
string ("User" | "Admin")
User role in Roam organization.
boolean
Whether the user account is active. Set to false to archive/deprovision the user. Defaults to true.
array
required
List of email addresses for the user. The primary email must match userName.
array
SCIM schemas to include in the request. Defaults to standard User schema.
string
required
Username for the user. Must be the user’s email address and must exactly match the primary email value.
string
External identifier for correlation with IdP records.
string
Full name of the user. Note: Roam auto-generates this from givenName + familyName, so this value may be ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The message text to send
object
Sender info with id, name, and imageUrl fields
boolean
Text is markdown by default. Set to false to disable markdown interpretation
array
required
Array of recipient UUIDs (currently supports single group). You can obtain the group ID on the Group Settings page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of user IDs to notify that you are typing. These are the recipients of the typing indicator.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

Input Parameters

object
required
The file to upload to Roam. The file name should match the filename to use (for example, ‘document.pdf’ or ‘image.jpg’).
string
Custom filename for the uploaded file. If not provided, the original filename from the FileUploadable object will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not