Reference

Account (me)

Use GET /v1/me to verify credentials and read the limits that apply to your key.

TuskMail API: Account (me)

Retrieve the current mailbox

GET/v1/me
curl "https://api.tuskmail.africa/v1/me" \
  -H "X-API-Key: $TK_API_KEY" \
  -u "$MAILBOX_EMAIL:$APP_PASSWORD"
200 OK
{
  "email": "[email protected]",
  "display_name": "Your Name",
  "domain": "yourcompany.co.ke",
  "api_key": { "id": 7, "name": "Order system", "prefix": "tk_live_a1b2c3" },
  "limits": { "requests_per_minute": 60, "messages_per_day": 1000 }
}
NameTypeDescription
emailstringThe mailbox the key is bound to.
display_namestringThe mailbox display name.
domainstringThe domain the mailbox belongs to.
api_keyobjectKey id, name and the non-secret prefix. The full key is never returned.
limitsobjectrequests_per_minute and messages_per_day for this key.