Get an enrollment

GET

programs

{programId}

enrollments

{id}

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

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

const { data, error } = await norbelys.programs.enrollments.find("prg_y3rgwmhkbgxx", "prg_y3rgwmhkbgxx");
if (error) {
  throw new Error(error.error.message);
}
console.log(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>"
}

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

string

required

The enrollment id (path).

Response

assignedSenderId

string | null

required

The mailbox owning the thread, once the first send fires, or null.

Example:

"snd_pfh0haxfpzowht3oi213cqos"

currentStepId

string | null

required

The cadence step the lead sits at, or null.

Example:

"stp_m8k2w9qe4r7t1y5u3i0o6pl2"

string

required

The enrollment id.

Example:

"enr_w1x5c9v3b7n2m6k0j4h8g2fd"

personId

string

required

The enrolled person's id.

Example:

"con_tz4a98xat96iws9zmbrgj3a"

programId

string

required

The owning program's id.

Example:

"prg_b2n4x8mq1w7e9rk3v5tz0yc6"

status

enum<string>

required

Lifecycle status: active, replied, bounced, unsubscribed, finished, skipped, stopped, cancelled, paused.

Available options:

active,

replied,

bounced,

unsubscribed,

finished,

skipped,

stopped,

cancelled,

paused

Example:

"active"

person

EnrollmentPersonRef · object | null

required

The enrolled person's display fields, joined.

Show child attributes

program

EnrollmentProgramRef · object | null

required

The owning program's id + name, joined for display.

Show child attributes

archivedAt

any

Soft-delete instant, or null when live.

createdAt

any

Enrollment instant (RFC 3339).

nextSendAt

any

When the next send is due (RFC 3339), or null.

object

any

default:enrollment

Always "enrollment".

updatedAt

any

Last-update instant (RFC 3339).

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

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

const { data, error } = await norbelys.programs.enrollments.find("prg_y3rgwmhkbgxx", "prg_y3rgwmhkbgxx");
if (error) {
  throw new Error(error.error.message);
}
console.log(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>"
}

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

Get an enrollment

Authorizations

Path Parameters

Response