Skip to main content
GET
/
emails
TypeScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const emailListResponse of client.emails.list()) {
  console.log(emailListResponse.id);
}
{
  "data": [
    {
      "id": "em_01jnvnn9avq52k5mrhn1gab0ch",
      "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
      "created_at": "2025-03-08T20:03:04.155Z",
      "from": "[email protected]",
      "to": "[email protected]",
      "subject": "Welcome to Tomlinson AI!",
      "status": "delivered",
      "status_at": "2025-03-08T20:03:04.155Z",
      "kind": "email",
      "region": "eu-west-1"
    },
    {
      "id": "em_01jnvnn9avq52k5mrhn1gab0ci",
      "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
      "created_at": "2025-03-08T20:03:04.155Z",
      "from": "[email protected]",
      "to": "[email protected]",
      "subject": "Welcome to Tomlinson AI!",
      "status": "delivered",
      "status_at": "2025-03-08T20:03:04.155Z",
      "kind": "email",
      "region": "eu-west-1"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Query Parameters

​
limit
number
default:10

The maximum number of items to return

Required range: 1 <= x <= 30
​
cursor
string

The cursor to use for pagination

Response

A successful response

​
data
object[]

The emails

Example:
[
  {
    "id": "em_01jnvnn9avq52k5mrhn1gab0ch",
    "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
    "created_at": "2025-03-08T20:03:04.155Z",
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Welcome to Tomlinson AI!",
    "status": "delivered",
    "status_at": "2025-03-08T20:03:04.155Z",
    "kind": "email",
    "region": "eu-west-1"
  },
  {
    "id": "em_01jnvnn9avq52k5mrhn1gab0ci",
    "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
    "created_at": "2025-03-08T20:03:04.155Z",
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Welcome to Tomlinson AI!",
    "status": "delivered",
    "status_at": "2025-03-08T20:03:04.155Z",
    "kind": "email",
    "region": "eu-west-1"
  }
]
​
next_cursor
string | null