Workspaces
Preview Workspace Mailboxes
GET
/v1/workspaces/{workspaceId}/previewGET
/v1/workspaces/
{workspaceId}/previewPreview mailboxes available to connect in a workspace
Lists mailboxes in the workspace not yet connected as email accounts. Also validates the workspace credentials actually work — if it fails, the workspace registration is deleted so it can be retried cleanly.
Authorization
X-Api-Key<token>
In: header
Path Parameters
workspaceIdstring
Query Parameters
searchstring
Search by email address or name
domainstring
Comma-separated list of domains to filter by
Responses
200
200 response
{
"newEmails": [
{
"email": "jane@customerdomain.com",
"displayName": "Jane Doe",
"domain": "customerdomain.com"
}
],
"total": 25,
"page": 1,
"limit": 10,
"connectedCount": 5,
"domains": [
{
"domain": "customerdomain.com",
"count": 25
}
]
}