See api-docs Menu

Get Email Settings Config

Use this API to return your org’s current Email Settings configuration.

Resource URL


Header Parameters




Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All, Read All.

Sample Responses

OneLogin default Email Settings configuration

    "mode": "onelogin_email"

Custom Email Settings configuration

   "address": "",
   "use_tls": true,
   "from": "",
   "domain": "",
   "user_name": "user-name",
   "mode": "custom_smtp_config",
   "password": "password",
   "port": 587

Typically, this error means that your access token value is invalid.

    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Branding API

Sample Code


Replace sample values indicated by < > with your actual values.

Get Email Settings Config

curl 'https://<subdomain>/api/2/branding/email_settings' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.