Read security settings

GET/api/v1/mailbox/security
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Whether two-factor sign-in is on, and how many recovery codes are left.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.

Request

GET/api/v1/mailbox/security
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/security' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • two_factor_enabledboolean
    • two_factor_confirmed_atstring or null
    • two_factor_pendingboolean

      Enrolment started, not yet confirmed.

    • recovery_codes_remaininginteger
200application/json
{
  "type": "success",
  "msg": "Security retrieved successfully",
  "data": {
    "two_factor_enabled": true,
    "two_factor_confirmed_at": "2026-09-20T12:00:00+00:00",
    "two_factor_pending": false,
    "recovery_codes_remaining": 8
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.

Every status, with what causes it and what to do, is on the error reference.