Noviqa SDK

Appearance

trader.mailboxes ​

1 method on trader.mailboxes. Each returns the answer's data and throws NoviqaError on a failed answer.

list ​

GET/trader/v1/mailboxes

Who the account may write to

The staff mailboxes a message from this account may go to (POST /trader/v1/mail to): staff with the mailbox right whose group scope covers the account's group. Empty when mail is off for the group.

Parameters
X-HST-Accountstring · header
Intended signed-in login captured by the browser tab before dispatch and retained across retries. A mismatch returns auth.account_changed (409) before mutation or refresh rotation. This never selects or authorizes an account; omission preserves existing API client compatibility.
Returns
Promise<Mailbox[]>
The answer's data.
Errors
400invalid_input: invalid input
401auth.session_expired: session expired, sign in again
403auth.invalid_terminal: this terminal cannot be used here
403auth.otp_enrol_required: your group requires one-time codes: set them up to continue
403auth.password_change_required: you must change your password first
409auth.account_changed: the signed-in account changed; sign in again before continuing
500internal: something went wrong
ts
import { trader } from "@/lib/noviqa"

const data = await trader.mailboxes.list()
bash
curl -X GET "$NOVIQA_API_URL/trader/v1/mailboxes" \
  -H "Authorization: Bearer $NOVIQA_TOKEN"
json
{
  "success": true,
  "code": "ok",
  "message": "done",
  "data": [
    {
      "login": 1001,
      "name": "Ann Smith"
    }
  ],
  "request_id": "5b7f2c1e"
}
ts
trader.mailboxes.list(options?: RequestOptions): Promise<mail.Mailbox[]>