List workspaces
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.
curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces"{
"data": [
{
"id": 0,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"quota": {
"dailyWarmupBudget": 0
},
"role": "owner"
}
],
"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"
}
}Get workspace sync statusGET
Poll the status of a bulk mailbox import
Create a workspacePOST
Provisions a new workspace in the organization - one per end-customer for a partner integration. Requires a personal (`ti_pk_`) key whose creator is an organization owner; a workspace-scoped key is rejected. Every organization owner, the key creator included, becomes an owner of the new workspace. The key acts as its creator and stops working if they leave or stop being an owner, so use a key owned by a service account rather than an individual. Pass `dailyWarmupBudget` to allocate the new workspace its daily warmup budget in the same call; that field also needs the `workspace:quota` scope.