Get workspace
curl --request GET \
--url https://console.mermail.app/api/v1/workspaces/{workspaceId} \
--header 'x-api-key: <api-key>'import requests
url = "https://console.mermail.app/api/v1/workspaces/{workspaceId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://console.mermail.app/api/v1/workspaces/{workspaceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.mermail.app/api/v1/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.mermail.app/api/v1/workspaces/{workspaceId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.mermail.app/api/v1/workspaces/{workspaceId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/workspaces/{workspaceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "ws_01abc",
"name": "Acme Agents",
"owner_address": "0xabc123def456",
"timezone": "America/New_York",
"role": "admin",
"mailbox_count": 2,
"storage": {
"provider": "harbor_r2",
"status": "ready",
"redundancy_enabled": true,
"storage_key_status": "ready",
"storage_key_last_error": null,
"space_id": "spc_01xyz",
"bucket_id": "bkt_01xyz",
"owner_address": "0xabc123def456",
"has_api_key": true,
"has_service_private_key": true,
"harbor_provisioning_status": "ready",
"harbor_last_error": null,
"r2_bucket_name": "mermail-ws-01abc",
"r2_provisioning_status": "ready",
"r2_last_error": null,
"last_error": null
},
"created_at": "2026-07-01T12:00:00.000Z",
"updated_at": "2026-07-15T08:00:00.000Z"
}{
"error": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Workspace not found"
}{
"error": "Too many requests"
}Workspaces
Get workspace
Plans: Free · Developer · Enterprise
Returns a single workspace the caller can access (includes nested storage). With an API key, workspaceId must match the key’s workspace (403 otherwise).
API credits: 1 (read).
GET
https://console.mermail.app
/
api
/
v1
/
workspaces
/
{workspaceId}
Get workspace
curl --request GET \
--url https://console.mermail.app/api/v1/workspaces/{workspaceId} \
--header 'x-api-key: <api-key>'import requests
url = "https://console.mermail.app/api/v1/workspaces/{workspaceId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://console.mermail.app/api/v1/workspaces/{workspaceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://console.mermail.app/api/v1/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.mermail.app/api/v1/workspaces/{workspaceId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.mermail.app/api/v1/workspaces/{workspaceId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.mermail.app/api/v1/workspaces/{workspaceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "ws_01abc",
"name": "Acme Agents",
"owner_address": "0xabc123def456",
"timezone": "America/New_York",
"role": "admin",
"mailbox_count": 2,
"storage": {
"provider": "harbor_r2",
"status": "ready",
"redundancy_enabled": true,
"storage_key_status": "ready",
"storage_key_last_error": null,
"space_id": "spc_01xyz",
"bucket_id": "bkt_01xyz",
"owner_address": "0xabc123def456",
"has_api_key": true,
"has_service_private_key": true,
"harbor_provisioning_status": "ready",
"harbor_last_error": null,
"r2_bucket_name": "mermail-ws-01abc",
"r2_provisioning_status": "ready",
"r2_last_error": null,
"last_error": null
},
"created_at": "2026-07-01T12:00:00.000Z",
"updated_at": "2026-07-15T08:00:00.000Z"
}{
"error": "Unauthorized"
}{
"error": "Invalid request"
}{
"error": "Forbidden"
}{
"error": "Workspace not found"
}{
"error": "Too many requests"
}Authorizations
API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.
Path Parameters
Workspace id
⌘I