Skip to content
Norbelys
Esc
↑↓navigate↵open⌘Jpreview

List the workspace's enrollments, newest first by default.

GET/v1/enrollments
Authorization
AuthorizationBearer token · headerrequired

An API key (nb_live_…, nb_test_…), a workspace token (nbs_…) or a CLI token (nbc_…).

Query parameters
limitinteger<int64>

Enrollments per page, 1 to 100 (default 20).

cursorstring

The next_cursor of the previous page.

orderstring

desc (default) or asc.

includestring

total_count adds an exact count up to 10,000: with sender_identity_id and status=active, what removing a sender would touch.

campaign_idstring

Enrollments of this campaign (cmp_…).

person_idstring

Enrollments of this person (per_…).

sender_identity_idstring

Conversations kept by this sender (sid_…).

statusstring

active, paused, completed, replied, stopped or failed.

Responses
200

A page of enrollments.

dataobject[]required

At most limit rows, 100 at most.

max items 100
Show properties
Array of object
campaign_idId_Campaignrequired
matches ^cmp_[0-9a-f]{32}$
created_atTimestamprequired
idId_Enrollmentrequired
matches ^enr_[0-9a-f]{32}$
message_idId_Message | null
Show properties
One of:
Id_Message
string
null
null
next_run_atTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
personPersonRefrequired

The person an enrollment is for.

Show properties
emailstringrequired
idId_Personrequired
matches ^per_[0-9a-f]{32}$
namestring | null

The given and family names, when the person has either.

positioninteger<int32>required

The step it is at, 1 for the first.

sender_identity_idId_SenderIdentity | null
Show properties
One of:
Id_SenderIdentity
string
null
null
statusEnrollmentStatusrequired

An enrollment's lifecycle (enrollments.status).

Allowed:activepausedcompletedrepliedstoppedfailed
status_detailstring | null

Why it ended, when it ended early.

updated_atTimestamprequired
waiting_forId_SenderIdentity | null
Show properties
One of:
Id_SenderIdentity
string
null
null
metaMetarequired

The page metadata.

Show properties
has_morebooleanrequired
next_cursorstring | null
total_countinteger<int64> | null

With ?include=total_count: exact up to 10,000.

total_count_cappedboolean | null

With ?include=total_count: true when the count stopped at 10,000.

400

The cursor is not valid for this request.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

401

No valid credential.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

403

The credential lacks campaigns:read.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

422

A parameter is invalid.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.norbelys.com/v1/enrollments' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": [
    {
      "campaign_id": "cmp_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "created_at": "2019-08-24T14:15:22Z",
      "id": "enr_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "message_id": "msg_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "next_run_at": "2019-08-24T14:15:22Z",
      "person": {
        "email": "string",
        "id": "per_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
        "name": "string"
      },
      "position": 0,
      "sender_identity_id": "sid_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "status": "active",
      "status_detail": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "waiting_for": "sid_0190f8a2b4c87a10b6d2e4f6a8c0e2f4"
    }
  ],
  "meta": {
    "has_more": true,
    "next_cursor": "string",
    "total_count": 0,
    "total_count_capped": true
  }
}