Skip to content
RosettaChat Docs
Search
Ctrl
K
Cancel
RosettaChat
Select theme
Dark
Light
Auto
Overview
Web Chat Widget
Widget quickstart
Configuration & appearance
Signed visitor identity
Webhooks
Webhooks overview
Outbound webhooks
Inbound webhooks
API Reference
Overview
App Authentication
Overview
Register
Login
Request OTP
Verify OTP
Forgot Password
Reset Password
Logout
Change Password
App Authentication - Social
Overview
Get OAuth Redirect URL
OAuth Callback
List Linked Accounts
Link Social Account
Complete Link Social Account
Unlink Social Account
Devices
Register a push device.
Unregister a push device.
Email Verification
Overview
Verify Email
Resend Verification Email
Endpoints
patchApiV1Me
getApiV1MeApiTokens
postApiV1MeApiTokens
deleteApiV1MeApiTokensToken_id
getApiV1MePersonalPlan
getApiV1MePersonalUsage
postApiV1MeBillingCheckout
postApiV1MeBillingPortal
postApiV1MeBillingSync
postApiV1MeBillingCouponRedeem
Public preview of an invite so the join screen can show what the user is about to join — even before they sign in.
Redeem an invite: add the authenticated user to the workspace.
getApiV1Workspaces
postApiV1Workspaces
getApiV1WorkspacesId
getApiV1DirectConversations
postApiV1DirectConversations
postApiV1DirectRecipientsResolve
getApiV1DirectConversationsConversation_idMessages
postApiV1DirectConversationsConversation_idMessages
Mark a direct conversation read up to its latest message for the current participant.
getApiV1MessageAttachmentsAttachment_idDownload
getApiV1DirectMessageAttachmentsAttachment_idDownload
getApiV1WorkspacesWorkspace_idChannels
postApiV1WorkspacesWorkspace_idChannels
putApiV1WorkspacesWorkspace_idChannelsId
deleteApiV1WorkspacesWorkspace_idChannelsId
getApiV1WorkspacesWorkspace_idMembers
putApiV1WorkspacesWorkspace_idMembersId
deleteApiV1WorkspacesWorkspace_idMembersId
getApiV1WorkspacesWorkspace_idInvites
postApiV1WorkspacesWorkspace_idInvites
deleteApiV1WorkspacesWorkspace_idInvitesId
getApiV1WorkspacesWorkspace_idWebhooksWebhook_idRequests
getApiV1WorkspacesWorkspace_idWebhooks
postApiV1WorkspacesWorkspace_idWebhooks
putApiV1WorkspacesWorkspace_idWebhooksId
deleteApiV1WorkspacesWorkspace_idWebhooksId
Current monthly usage and plan limits for a workspace (members only).
List the explicit members of a private channel.
Add an existing workspace member to a private channel.
Remove a member from a private channel.
Cursor-paginated channel history. Returns the newest `limit` messages by default, oldest-first for display. Pass `before=<messageId>` to fetch the window immediately older than that cursor (ULID ordering, ties-free).
postApiV1WorkspacesWorkspace_idChannelsChannel_idMessages
Full thread payload for a root message: the root plus all of its replies, oldest-first. Independent of the channel pagination window so threads load reliably even for old roots scrolled out of the main history.
Mark a channel read up to its latest message for the current member.
postApiV1AutomationWorkspacesWorkspace_idChannelsChannel_idMessages
postApiV1WebhooksWebhook_idMessages
External Temporary Rooms
Join a Temporary Room as a guest
List guest-visible room messages
Send a guest room message
Files
Upload a file.
Show file metadata.
Delete a file (soft delete + remove from disk).
Stream the file contents to the client.
Me
List my files.
List my push devices.
Outbound Webhooks
Overview
getApiV1WorkspacesWorkspace_idOutboundWebhooks
postApiV1WorkspacesWorkspace_idOutboundWebhooks
deleteApiV1WorkspacesWorkspace_idOutboundWebhooksWebhook_id
patchApiV1WorkspacesWorkspace_idOutboundWebhooksWebhook_id
postApiV1WorkspacesWorkspace_idOutboundWebhooksWebhook_idTest
getApiV1WorkspacesWorkspace_idOutboundWebhooksWebhook_idDeliveries
postApiV1WorkspacesWorkspace_idOutboundWebhooksWebhook_idDeliveriesDelivery_idRetry
Shared Authentication
Overview
Get Current User
Support Analytics
Overview
getApiV1WorkspacesWorkspace_idSupportAnalytics
Support Inbox
Overview
List the support conversations the authenticated agent can handle.
Show a single conversation.
getApiV1SupportConversationsConversation_idMessages
postApiV1SupportConversationsConversation_idMessages
List the workspace's support agents for the assignment picker.
postApiV1SupportConversationsConversation_idAssign
postApiV1SupportConversationsConversation_idUnassign
postApiV1SupportConversationsConversation_idSnooze
postApiV1SupportConversationsConversation_idClose
postApiV1SupportConversationsConversation_idReopen
getApiV1SupportConversationsConversation_idNotes
postApiV1SupportConversationsConversation_idNotes
deleteApiV1SupportConversationsConversation_idNotesId
patchApiV1SupportConversationsConversation_idNotesId
postApiV1SupportConversationsConversation_idTags
deleteApiV1SupportConversationsConversation_idTagsTag_id
getApiV1WorkspacesWorkspace_idSupportTags
postApiV1WorkspacesWorkspace_idSupportTags
deleteApiV1WorkspacesWorkspace_idSupportTagsTag_id
patchApiV1WorkspacesWorkspace_idSupportTagsTag_id
getApiV1WorkspacesWorkspace_idSupportCannedResponses
postApiV1WorkspacesWorkspace_idSupportCannedResponses
deleteApiV1WorkspacesWorkspace_idSupportCannedResponsesCannedResponse_id
patchApiV1WorkspacesWorkspace_idSupportCannedResponsesCannedResponse_id
Support Widget Admin
Overview
getApiV1WorkspacesWorkspace_idWidgetConfig
postApiV1WorkspacesWorkspace_idWidgetConfig
patchApiV1WorkspacesWorkspace_idWidgetConfig
Generate (or rotate) the per-site identity-signing secret used to verify signed visitor identities. Returned exactly once — like the public key, the raw value never appears in the normal show/update responses.
getApiV1WorkspacesWorkspace_idSupportBotConfig
putApiV1WorkspacesWorkspace_idSupportBotConfig
getApiV1WorkspacesWorkspace_idSupportBotConfigMarknestFolders
getApiV1WorkspacesWorkspace_idSupportBotConfigMarknestTags
postApiV1WorkspacesWorkspace_idSupportBotConfigTest
getApiV1WorkspacesWorkspace_idSupportWebhooks
postApiV1WorkspacesWorkspace_idSupportWebhooks
deleteApiV1WorkspacesWorkspace_idSupportWebhooksWebhook_id
patchApiV1WorkspacesWorkspace_idSupportWebhooksWebhook_id
postApiV1WorkspacesWorkspace_idSupportWebhooksWebhook_idTest
Temporary Rooms
List owned Temporary Rooms
Create a Temporary Room
Show a Temporary Room
Close a Temporary Room
Update a Temporary Room
Show Temporary Room usage summary
Extend a Temporary Room
Web Authentication
Overview
Register
Login
Request OTP
Verify OTP
Forgot Password
Reset Password
Logout
Change Password
Web Authentication - Social
Overview
Get OAuth Redirect URL
Browser OAuth Callback
OAuth Callback
List Linked Accounts
Link Social Account
Complete Link Social Account
Unlink Social Account
Sandbox & Testing
Sandbox & testing
RosettaChat
Select theme
Dark
Light
Auto
Overview
Support Analytics
Section titled “Support Analytics”
Read-only support-desk metrics for a workspace over a period.