Version: 1.0

Roam HQ API

The Roam HQ API is your programmatic interface to your all-in-one Virtual Office.

OpenAPI Spec: openapi.json

Other APIs:

• On-Air API (events, guests, attendance) — onair.json
• Alpha API (chat, users, meetings) — chat.json
• SCIM 2.0 API (user provisioning) — scim.json
• Webhooks API (real-time events) — webhooks.json

Endpoints Overview

Endpoint	Method	Description
/chat.sendMessage	POST	Send a message to a group as a bot
/asset.create	POST	Create an asset and get upload instructions for its bytes
/story.post	POST	Post a story as the authenticated user (Personal tokens only)
/groups.list	GET	List all public groups in your Roam
/recording.list	GET	List meeting recordings with optional date filtering
/messageevent.export	POST	Export daily message archives (DMs and group chats)
/magicast.list	GET	List magicasts
/magicast.info	GET	Get a magicast by ID

Common Use Cases

Send Notifications to Groups

Integrate external services (CI/CD, monitoring, ticketing) to post alerts into Roam groups.

• Use /groups.list to let users pick a destination
• Use /chat.sendMessage to post updates

Compliance & Archival

Export message events daily for compliance, legal holds, or data warehousing.

• Use /messageevent.export to retrieve daily archives

Process Recordings

Build workflows to archive or transcribe recordings.

• Use /recording.list to fetch available recordings

Post Stories

Share photo or video updates with your teammates programmatically (Personal tokens only).

• Use /asset.create with purpose: "story" to upload the media
• Use /story.post to post it as your story

Authentication

All requests require a Bearer token. Create an API Key or OAuth app in Roam Administration > Developer.

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.ro.am/v1

---

Have questions? Contact us via Roam Support Chat or email developer@ro.am.

Authentication

HTTP: Bearer Auth

Pass your API Key or OAuth access token as a Bearer token. Example: Authorization: Bearer <token>

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer

Contact

Developer Support: developer@ro.am

URL: https://developer.ro.am

Terms of Service

https://ro.am/terms