Email White Label - Get (Mandrill status)

Returns the company's email white-label record plus live Mandrill verification status. Loads the latest VerifiedEmail for company_id, then queries Mandrill for sender-domain verification (/senders/verify-domain, /senders/check-domain) and tracking-domain status (/urls/check-tracking-domain, auto-adding it via /urls/add-tracking-domain if unknown), and includes the platform default sender settings.

Auth: Both — authentication, role-agnostic account/white-label prefix. company_id is required and scoped by an ownership check (must be in the caller's hierarchy). A partner can read any company beneath it, an account user only its own part of the account tree. Invalid/out-of-hierarchy ids return 422.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
company_idintegerrequiredMust be an existing account inside your own account tree.

Response{ data. } envelope.

  • status (string) — "success".
  • data (object|null) — the VerifiedEmail row (id, company_id, email, name, domain, tracking_url, domain_verified_at, url_verified_at, timestamps), or null if none.
  • verification (object) — verify_domain, check_domain, check_tracking_domain (raw Mandrill responses; empty objects when no model/domain), and default_settings (email, name, tracking_url from config('mail.*')).
  • instruction_file (string) — versioned asset URL to the email-setup PDF.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json