List programs

GET

programs

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

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

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

{
  "data": [
    {
      "activeDays": [
        1,
        2,
        3,
        4,
        5
      ],
      "addUnsubscribe": true,
      "autoPauseOnCompanyReply": true,
      "bouncePauseThreshold": 2,
      "id": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
      "jitterMaxSeconds": 60,
      "jitterMinSeconds": 30,
      "kind": "cold_sequence",
      "name": "Q3 outbound — founders",
      "newPerDay": 25,
      "pausedMeta": {
        "rate": 6.7,
        "threshold": 2
      },
      "pausedReason": "bounce_rate",
      "plainTextMode": true,
      "senderTags": [
        "acme-pool"
      ],
      "sendIntervalMinutes": 5,
      "spamPauseThreshold": 0.3,
      "status": "active",
      "stopCondition": "reply",
      "timezone": "America/Chicago",
      "timezoneSource": "sender",
      "trackClicks": true,
      "trackingDomainId": "<string>",
      "trackOpens": true,
      "unsubscribeText": "<string>",
      "variantDistribution": "pattern",
      "windowFrom": "09:00",
      "windowTo": "17:00",
      "stats": {
        "completion": 0.62,
        "leadCount": 480,
        "nextSendAt": "<unknown>"
      },
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "object": "program",
      "pausedAt": "<unknown>",
      "startDate": "2026-07-01T14:00:00.000Z",
      "updatedAt": "<unknown>"
    }
  ],
  "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_….

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

dir

enum<string>

Sort direction: "asc" or "desc". Defaults to "desc".

Available options:

asc,

desc

page

integer

1-based page number for offset-paginated browsing. Example: 2

Required range: x >= 1

archived

boolean

Show only archived campaigns.

string

Name search (case-insensitive substring).

Example:

"founders"

senderId

string

Scope to the campaigns a given mailbox is assigned to.

Example:

"snd_pfh0haxfpzowht3oi213cqos"

sort

enum<string>

Sort column: created, name, status. Defaults to created.

Available options:

created,

name,

status

status

enum<string>[]

Match any of these statuses: draft, active, paused, done.

Available options:

draft,

active,

paused,

done

Example:

["active", "paused"]

Response

data

ProgramListItem · 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.list();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "data": [
    {
      "activeDays": [
        1,
        2,
        3,
        4,
        5
      ],
      "addUnsubscribe": true,
      "autoPauseOnCompanyReply": true,
      "bouncePauseThreshold": 2,
      "id": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
      "jitterMaxSeconds": 60,
      "jitterMinSeconds": 30,
      "kind": "cold_sequence",
      "name": "Q3 outbound — founders",
      "newPerDay": 25,
      "pausedMeta": {
        "rate": 6.7,
        "threshold": 2
      },
      "pausedReason": "bounce_rate",
      "plainTextMode": true,
      "senderTags": [
        "acme-pool"
      ],
      "sendIntervalMinutes": 5,
      "spamPauseThreshold": 0.3,
      "status": "active",
      "stopCondition": "reply",
      "timezone": "America/Chicago",
      "timezoneSource": "sender",
      "trackClicks": true,
      "trackingDomainId": "<string>",
      "trackOpens": true,
      "unsubscribeText": "<string>",
      "variantDistribution": "pattern",
      "windowFrom": "09:00",
      "windowTo": "17:00",
      "stats": {
        "completion": 0.62,
        "leadCount": 480,
        "nextSendAt": "<unknown>"
      },
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "object": "program",
      "pausedAt": "<unknown>",
      "startDate": "2026-07-01T14:00:00.000Z",
      "updatedAt": "<unknown>"
    }
  ],
  "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

Authorizations

Query Parameters

Response