Retrieve the organization's email settings

GET

/api/organizations/settings/email

const url = 'https://example.com/api/organizations/settings/email';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/organizations/settings/email \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Responses

200

Email settings retrieved successfully

application/json

object

provider

required

Transactional email provider service type (smtp, sendgrid, postmark, ses).

string

fromEmail

required

Default sender email address for system-generated outbound messages.

string

fromName

Default sender display name for outbound emails.

string

Example

{
  "provider": "sendgrid",
  "fromEmail": "[email protected]",
  "fromName": "Dream Center Connect System"
}

401

Unauthorized

403

Forbidden