Skip to main content

Endpoint

Overview

This endpoint allows you to check if email forwarding is currently enabled on your account, and view the forwarding email address if set.

Authentication

This endpoint requires an API key. You can retrieve an API key from your dashboard. Include it in the X-API-KEY header:
For more details, see the Authentication Guide.

Parameters

None
This endpoint does not require any path, query, or request body parameters.

Request Examples

cURL

Python

JavaScript (Fetch)

Responses

200 OK

Returns the forwarding status and forwarding email.

401 Unauthorized

Occurs if authentication fails (e.g., missing or invalid API key).

500 Internal Server Error

A server-side error occurred.

Note on 404 from DB

If your profile does not yet exist in the database, the API gracefully returns:

Need Further Assistance?

If you have any questions or encounter issues, please don’t hesitate to reach out to our support team.