Public APIv256 endpoints

Warm up mailboxes from your own code.

A REST surface over your TrulyInbox workspaces - email accounts, warmup, deliverability, reports and notifications. One bearer key authenticates all of it.

Make your first callBrowse the reference

Every endpoint page carries a Try it panel that sends a real request with your key, so you can confirm a call works before writing any code.

GET/v2/workspaces/123/tags
Hostlynx-api.trulyinbox.com
AuthorizationBearer ti_ws_your_key_here
Acceptapplication/json
200 OK
{
  "success": true,
  "data": [{ "id": 1, "name": "production" }],
  "errorCode": null,
  "errorMessage": null
}

Three values you supply

Everything else in a request is fixed. These are the parts that are yours, and the order you get them in.

  1. 01

    Create a key

    Open Settings → API keys in the TrulyInbox app. Copy the key when it appears: it is shown once and cannot be retrieved again.

    Key types and scopes →

  2. 02

    Find your workspace id

    Every path is workspace-scoped - /v2/workspaces/{id}/… - so a call needs the numeric id of the workspace you are reading or changing.

    Where to find it →

  3. 03

    Grant the scope

    Each endpoint requires one scope, and the key’s role in the workspace caps it. A key without the scope gets a 403, not a 401.

    Scope reference →

The whole surface

56 endpoints in 9 groups. Every path is prefixed with /v2/workspaces/{workspaceId}.

System

Email Accounts

Workspaces

Workspace Settings

Billing

Warmup

Deliverability

Reports

Notifications

When a call fails

Every response uses one envelope. Failures carry a 6-digit code that names the cause - the full catalog, with the status each code returns.

Your request budget

Limits are counted per key, per minute, with separate read and write budgets - plus the headers that tell you what you have left.