Get Authenticator code

GET

/v2/mailboxes/authenticator-code

This endpoint allows you to retrieve an authenticator code for a specific mailbox. The code can be used for authentication purposes and has a limited validity period.

Note
The expiresIn field in the response indicates the number of seconds after which the current code will expire.
After expiration, you must re-hit the API to obtain a new code, as the old one will no longer be valid.
domainId is optional and can only be used with Microsoft domains to fetch the OTP for the admin account of the given domain.

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Domain id only for MS

🟠4002FA Not set

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.zapmail.ai/api/v2/mailboxes/authenticator-code?mailboxId=&domainId' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Response Example

200 - Success

{
    "status": 200,
    "message": "Unique exports fetched successfully",
    "data": {
        "otp": "246043",
        "expiresIn": 4
    }
}

Modified at 2025-10-14 09:22:03

Remove mailboxes on next renewal

Custom OAuth