List email settings | Intercom API (unofficial showcase)

1 parameter

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

2 status codes

200Returns an object containing a `data` array of email setting objects, including sender address, verification, domain, brand, and forwarding details.

typestringoptional

The type of object

dataarray<EmailSetting>optional

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

Error handling

A 401 is returned when the request is unauthorized. The Intercom-Version header defaults to 2.17 when omitted; if you provide it, use a supported API version.

import { Client } from "@octridev/intercom";

const client = new Client({
  baseUrl: "https://api.intercom.io",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.emails.list();

{
  "type": "list",
  "data": [
    {
      "type": "email_setting",
      "id": "1",
      "email": "support@company.com",
      "verified": true,
      "domain": "company.com",
      "brand_id": "9",
      "forwarding_enabled": true,
      "forwarded_email_last_received_at": 1710498600,
      "created_at": 1692530400,
      "updated_at": 1710498600
    },
    {
      "type": "email_setting",
      "id": "2",
      "email": "hello@company.com",
      "verified": true,
      "domain": "company.com",
      "brand_id": "10",
      "forwarding_enabled": false,
      "forwarded_email_last_received_at": null,
      "created_at": 1683729000,
      "updated_at": 1701424500
    }
  ]
}

Request

Response

Errors