Get
/api/v1/cloud.registrationStatus
Returns the workspace's current Rocket.Chat Cloud registration status.
Permission required: manage-cloud.
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200
OK
Example
{
"registrationStatus": {
"workspaceRegistered": true,
"workspaceId": "abc123-workspace-id",
"uniqueId": "xyz789-unique-id",
"token": "",
"email": "admin@example.com"
},
"success": true
}object
registrationStatus
object
workspaceRegistered
boolean
Whether the workspace has an active Cloud Client ID and Secret configured.
workspaceId
string
The workspace's Rocket.Chat Cloud ID.
uniqueId
string
The workspace's unique installation ID.
token
string
email
string
The registered organization email on Rocket.Chat Cloud.
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}object
success
boolean
error
string