Intercom API (unofficial showcase)
GET/emails/{id}

Retrieve an email setting

Retrieves a sender email address setting by its unique identifier. Use this operation to inspect an individual setting, including its verification status, associated brand, and forwarding details.

2 parameters
idstringrequired
The unique identifier of the email setting to retrieve.
Intercom-Versionstringoptional
The API version to use. Defaults to `2.17` when omitted; the schema lists `1.0` through `1.4` and `2.0` through `2.6`, with additional values also supported.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns an email setting object containing its identifier, sender address, verification status, domain, associated brand, forwarding status, and creation and update timestamps.
typestringoptional
The type of object
idstringoptional
Unique email setting identifier
emailstringoptional
Full sender email address
verifiedbooleanoptional
Whether the email address has been verified
domainstringoptional
Domain portion of the email address
brand_idstringoptional
Associated brand identifier
forwarding_enabledbooleanoptional
Whether email forwarding is active
forwarded_email_last_received_atintegeroptional
Unix timestamp of last forwarded email received (null if never)
created_atintegeroptional
Unix timestamp of creation
updated_atintegeroptional
Unix timestamp of last modification
401Returned when the request is unauthorized.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the email setting does not exist.

One documented failure

  • not_found

    Email setting not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the id path parameter does not identify an email setting. The Intercom-Version header defaults to 2.17 when omitted; if you provide it, use a supported API version.