Preview workspace mailboxes
Preview mailboxes available to connect in a provider workspace
Paginated directory listing, excluding mailboxes already connected. Filter with domain and search to build the selection for .../sync.
Path Parameters
Query Parameters
150Substring match on email or display name.
Restrict the preview to these domains (OR match). A single query value holding a JSON array, e.g. domain=["a.com","b.com"]. Empty/absent = all domains.
Response Body
curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/provider-workspaces/0/preview?page=1&limit=50&search=string&domain=string"{
"data": {
"newEmails": [
{
"email": "string",
"displayName": {},
"domain": "string"
}
],
"total": 0,
"page": 0,
"limit": 0,
"connectedCount": 0,
"domains": [
{
"domain": "string",
"count": 0
}
]
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"details": {},
"retry_after": 34
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"details": {},
"retry_after": 34
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}Register a workspacePOST
Register a Google Workspace or Microsoft 365 tenant Google: supply `adminEmail`, a super-admin mailbox the service account impersonates for Directory discovery. Microsoft: supply the `tenantId` and `state` returned by the admin-consent redirect. Registering only makes the tenant's mailboxes discoverable - nothing is connected until .../sync runs.
Confirm workspace syncPOST
Start the bulk mailbox import Asynchronous - returns 202 with a `jobId`. Selection is deselect-based: with `selectAll` every not-yet-connected directory mailbox is connected (optionally restricted to `selectedDomains`) minus `deselect`; otherwise only `emailsToConnect`. Poll .../sync-status for progress.