Skip to main content
GET
/
messages
JavaScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: process.env['NUNTLY_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const message of client.messages.list()) {
  console.log(message.id);
}
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "<string>",
      "domainId": "<string>",
      "domainName": "<string>",
      "inboxId": "<string>",
      "threadId": "<string>",
      "inbox": {
        "id": "<string>",
        "address": "<string>",
        "name": "<string>"
      },
      "fromAddress": "<string>",
      "fromName": "<string>",
      "toAddresses": [
        {
          "address": "jsmith@example.com",
          "name": "<string>"
        }
      ],
      "ccAddresses": [
        {
          "address": "jsmith@example.com",
          "name": "<string>"
        }
      ],
      "subject": "<string>",
      "receivedAt": "<string>",
      "direction": "received",
      "status": "received",
      "spfVerdict": "<string>",
      "dkimVerdict": "<string>",
      "spamVerdict": "<string>",
      "virusVerdict": "<string>",
      "attachmentCount": 123
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

The cursor to retrieve the next page of results

limit
number
default:30

The maximum number of results to return

Required range: 1 <= x <= 30
domainId
string

Filter by domain.

from
string

Filter by sender address.

spamVerdict
enum<string>

Filter by spam verdict.

Available options:
PASS,
FAIL

Response

Successful response.

data
object[]
required
nextCursor
string