List a program's leads

GET

programs

{programId}

enrollments

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

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

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

{
  "data": [
    {
      "assignedSenderId": "snd_pfh0haxfpzowht3oi213cqos",
      "currentStepId": "stp_m8k2w9qe4r7t1y5u3i0o6pl2",
      "id": "enr_w1x5c9v3b7n2m6k0j4h8g2fd",
      "personId": "con_tz4a98xat96iws9zmbrgj3a",
      "programId": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
      "status": "active",
      "person": {
        "email": "<string>",
        "id": "<string>",
        "name": "<string>"
      },
      "program": {
        "id": "<string>",
        "name": "<string>"
      },
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "nextSendAt": "<unknown>",
      "object": "enrollment",
      "updatedAt": "<unknown>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "counts": {
    "active": 1,
    "bounced": 1,
    "cancelled": 1,
    "finished": 1,
    "inProgress": 1,
    "notStarted": 1,
    "paused": 1,
    "replied": 1,
    "skipped": 1,
    "stopped": 1,
    "total": 1,
    "unsubscribed": 1,
    "byStep": {},
    "nextSendAt": "<unknown>"
  },
  "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

programId

string

required

The owning program id (path).

Example:

"prg_b2n4x8mq1w7e9rk3v5tz0yc6"

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

string

Free-text search over the enrolled person's email, first or last name (narrows the page and the counts).

sort

enum<string>

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

Available options:

created,

updated,

status

status

enum<string>[]

Match any of these statuses: active, replied, bounced, unsubscribed, finished, skipped, stopped, cancelled, paused.

Available options:

active,

replied,

bounced,

unsubscribed,

finished,

skipped,

stopped,

cancelled,

paused

Example:

["active"]

Response

data

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

counts

EnrollmentCounts · object

required

Enrollment-status counts for the whole queried scope (they ignore the status filter).

Show child attributes

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

{
  "data": [
    {
      "assignedSenderId": "snd_pfh0haxfpzowht3oi213cqos",
      "currentStepId": "stp_m8k2w9qe4r7t1y5u3i0o6pl2",
      "id": "enr_w1x5c9v3b7n2m6k0j4h8g2fd",
      "personId": "con_tz4a98xat96iws9zmbrgj3a",
      "programId": "prg_b2n4x8mq1w7e9rk3v5tz0yc6",
      "status": "active",
      "person": {
        "email": "<string>",
        "id": "<string>",
        "name": "<string>"
      },
      "program": {
        "id": "<string>",
        "name": "<string>"
      },
      "archivedAt": "<unknown>",
      "createdAt": "<unknown>",
      "nextSendAt": "<unknown>",
      "object": "enrollment",
      "updatedAt": "<unknown>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "counts": {
    "active": 1,
    "bounced": 1,
    "cancelled": 1,
    "finished": 1,
    "inProgress": 1,
    "notStarted": 1,
    "paused": 1,
    "replied": 1,
    "skipped": 1,
    "stopped": 1,
    "total": 1,
    "unsubscribed": 1,
    "byStep": {},
    "nextSendAt": "<unknown>"
  },
  "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 leads

Authorizations

Path Parameters

Query Parameters

Response