Docs
Workspaces

Get workspace sync status

Poll the status of a bulk mailbox import

GET
/v2/workspaces/{workspaceId}/provider-workspaces/{providerWorkspaceId}/sync-status

Path Parameters

providerWorkspaceIdnumber
workspaceIdnumber

Query Parameters

jobIdstring

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/provider-workspaces/0/sync-status?jobId=string"
{
  "data": {
    "jobId": "string",
    "status": "pending",
    "total": 0,
    "processed": 0,
    "succeeded": 0,
    "failed": 0,
    "failures": [
      {
        "email": "string",
        "error": "string"
      }
    ],
    "items": [
      "string"
    ]
  },
  "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"
  }
}

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.

List workspacesGET

The workspaces the key can reach. A personal (`ti_pk_`) key returns every workspace in its organization; it needs the `workspace:provision` scope and a creator who is an organization owner. A workspace (`ti_ws_`) key returns only the one workspace it is bound to, as a single-element array; it needs the `workspace:read` scope. A missing scope, or a personal key whose creator is not an organization owner, is refused with 403.