List messages

GET

messages

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

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

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

{
  "data": [
    {
      "contactEmail": "[email protected]",
      "contactName": "<string>",
      "id": "act_y3rgwmhkbgxxa2qzmfyrdj0e",
      "personId": "con_mfyrdj0ey3rgwmhkbgxxa2qz",
      "senderId": "snd_y3rgwmhkbgxxa2qzmfyrdj0e",
      "subject": "Quick question, Ada",
      "threadId": "<string>",
      "channel": "email",
      "direction": "outbound",
      "failureCode": "dlq_exhausted",
      "isTest": true,
      "programId": "prg_a2qzmfyrdj0ey3rgwmhkbgxx",
      "status": "sent",
      "stepId": "stp_mfyrdj0ey3rgwmhkbgxxa2qz",
      "object": "message",
      "occurredAt": "2026-06-10T15:04:05.000Z"
    }
  ],
  "hasMore": true,
  "nextCursor": null,
  "total": 1284,
  "page": 1,
  "object": "list"
}

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

channel

enum<string>

Filter by channel: email, call, sms, linkedin.

Available options:

email,

call,

sms,

linkedin

Example:

"email"

classification

enum<string>

Filter by inbound triage class: interested, out_of_office, not_interested, auto_reply, bounce, complaint, unsubscribe, uncategorized.

Available options:

interested,

out_of_office,

not_interested,

auto_reply,

bounce,

complaint,

unsubscribe,

uncategorized

Example:

"interested"

dir

enum<string>

Sort direction: asc or desc.

Available options:

asc,

desc

direction

enum<string>

Filter by direction: outbound or inbound (inbound = the unibox); omit to interleave both.

Available options:

outbound,

inbound

Example:

"inbound"

string

Pin the log to one email address, matched against the other party (covers inbound senders with no person); substring, case-insensitive.

Example:

"[email protected]"

isRead

boolean

Inbound read-flag filter (false = unread).

limit

integer

Page size, 1-500. Defaults to 50.

Required range: 1 <= x <= 500

orderBy

enum<string>

Sort key: occurredAt or subject. Defaults to occurredAt.

Available options:

occurredAt,

subject

page

integer

1-based page number.

Required range: x >= 1

Example:

2

personId

string

Scope to one person.

Example:

"con_mfyrdj0ey3rgwmhkbgxxa2qz"

programId

string

Scope to one campaign.

Example:

"prg_a2qzmfyrdj0ey3rgwmhkbgxx"

string

Matches subject + the other party's email.

senderId

string

Scope to one mailbox (its full send/receive history).

Example:

"snd_y3rgwmhkbgxxa2qzmfyrdj0e"

status

enum<string>

Filter by outbound status: queued, sent, delivered, failed, bounced, cancelled.

Available options:

queued,

sent,

delivered,

failed,

bounced,

cancelled

Example:

"bounced"

stepId

string

Scope to one cadence step's sends. Outbound-only — inbound replies carry no step, so combining with direction: inbound returns nothing.

Example:

"stp_mfyrdj0ey3rgwmhkbgxxa2qz"

threadId

string

Group a conversation: every message sharing this thread id.

Response

data

(OutboundMessage · object | InboundMessage · object)[]

required

The page of results, newest first.

OutboundMessage
InboundMessage

Show child attributes

hasMore

boolean

required

Whether another page exists beyond this one.

nextCursor

null

required

Always null for messages because this endpoint uses page-number pagination.

total

integer

required

Count across both directions matching the filters.

Required range: x >= 0

Example:

1284

page

integer

required

The 1-based page returned.

Required range: x >= 1

Example:

1

object

any

default:list

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

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

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

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

{
  "data": [
    {
      "contactEmail": "[email protected]",
      "contactName": "<string>",
      "id": "act_y3rgwmhkbgxxa2qzmfyrdj0e",
      "personId": "con_mfyrdj0ey3rgwmhkbgxxa2qz",
      "senderId": "snd_y3rgwmhkbgxxa2qzmfyrdj0e",
      "subject": "Quick question, Ada",
      "threadId": "<string>",
      "channel": "email",
      "direction": "outbound",
      "failureCode": "dlq_exhausted",
      "isTest": true,
      "programId": "prg_a2qzmfyrdj0ey3rgwmhkbgxx",
      "status": "sent",
      "stepId": "stp_mfyrdj0ey3rgwmhkbgxxa2qz",
      "object": "message",
      "occurredAt": "2026-06-10T15:04:05.000Z"
    }
  ],
  "hasMore": true,
  "nextCursor": null,
  "total": 1284,
  "page": 1,
  "object": "list"
}

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