List senders

GET

senders

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.senders.list();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "data": [
    {
      "bccCrmEmail": "[email protected]",
      "clientLabel": "Acme Corp",
      "dailyLimit": 50,
      "fromEmail": "[email protected]",
      "fromName": "Ada from Acme",
      "id": "snd_pfh0haxfpzowht3oi213cqos",
      "imapHost": "imap.gmail.com",
      "imapPort": 993,
      "imapSecurity": "ssl",
      "minGapMinutes": 5,
      "replyTo": "[email protected]",
      "reputation": "good",
      "sendingDomainId": "dom_tz4a98xat96iws9zmbrgj3a",
      "signatureHtml": "<string>",
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 465,
      "smtpSecurity": "ssl",
      "state": "healthy",
      "tags": [
        "acme-pool",
        "us"
      ],
      "transportMode": "smtp",
      "transportProvider": "google",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "healthUpdatedAt": "<unknown>",
      "object": "sender",
      "updatedAt": "<unknown>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "total": 7,
  "object": "list"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Query Parameters

cursor

string

Opaque cursor from a previous page's nextCursor — returns results strictly after it. Example: "con_x7q2m9k4w8r1"

includeArchived

boolean

Include archived rows in the results (hidden by default). Example: true

limit

integer

Page size, 1-100. Defaults to 50. Example: 25

Required range: 1 <= x <= 100

ids

string[]

Only return these mailbox ids (maximum 100).

Maximum array length: 100

reputation

enum<string>[]

Match any of these reputation tiers: good, warning, or bad.

Available options:

good,

warning,

bad

Example:

["good"]

string

Matches fromName, fromEmail and clientLabel.

sendingDomainId

string

Only return mailboxes on this sending domain.

state

enum<string>[]

Match any of these states: healthy, throttled, or paused.

Available options:

healthy,

throttled,

paused

Example:

["healthy"]

Response

data

Sender · object[]

required

The page of results, newest first.

Show child attributes

hasMore

boolean

required

Whether another page exists beyond this one.

nextCursor

string | null

required

Pass as cursor to fetch the next page; null when this is the last page.

total

integer

required

Count of all senders matching the filters.

Required range: x >= 0

Example:

7

object

any

default:list

Always "list", marking this response as a collection.

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.senders.list();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "data": [
    {
      "bccCrmEmail": "[email protected]",
      "clientLabel": "Acme Corp",
      "dailyLimit": 50,
      "fromEmail": "[email protected]",
      "fromName": "Ada from Acme",
      "id": "snd_pfh0haxfpzowht3oi213cqos",
      "imapHost": "imap.gmail.com",
      "imapPort": 993,
      "imapSecurity": "ssl",
      "minGapMinutes": 5,
      "replyTo": "[email protected]",
      "reputation": "good",
      "sendingDomainId": "dom_tz4a98xat96iws9zmbrgj3a",
      "signatureHtml": "<string>",
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 465,
      "smtpSecurity": "ssl",
      "state": "healthy",
      "tags": [
        "acme-pool",
        "us"
      ],
      "transportMode": "smtp",
      "transportProvider": "google",
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "healthUpdatedAt": "<unknown>",
      "object": "sender",
      "updatedAt": "<unknown>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "total": 7,
  "object": "list"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Authorizations

Query Parameters

Response