List a program's senders

GET

programs

{id}

senders

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

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

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

{
  "data": [
    {
      "fromEmail": "[email protected]",
      "fromName": "Ada from Acme",
      "id": "snd_pfh0haxfpzowht3oi213cqos",
      "dailyLimit": 50,
      "minGapMinutes": 6,
      "nextSendAt": "<unknown>",
      "poolQueued": 9814,
      "queued": 12,
      "reputation": "good",
      "state": "healthy",
      "via": "tag"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "object": "list",
  "total": 1284
}

{
  "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_….

Path Parameters

string

required

The resource id (path).

Response

A page of programs senders results.

data

ProgramSenderRef · 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.

object

any

default:list

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

total

integer

Total number of rows matching the filters. Not included on every list.

Required range: x >= 0

Example:

1284

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

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

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

{
  "data": [
    {
      "fromEmail": "[email protected]",
      "fromName": "Ada from Acme",
      "id": "snd_pfh0haxfpzowht3oi213cqos",
      "dailyLimit": 50,
      "minGapMinutes": 6,
      "nextSendAt": "<unknown>",
      "poolQueued": 9814,
      "queued": 12,
      "reputation": "good",
      "state": "healthy",
      "via": "tag"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "object": "list",
  "total": 1284
}

{
  "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

List a program's senders

Authorizations

Path Parameters

Response