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

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

sort=last_activity_at orders them by their latest message, sent or received, instead: the inbox’s order. A thread moves when a message arrives, so it can move between pages while they are read.

GET/v1/threads
Authorization
AuthorizationBearer token · headerrequired

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

Query parameters
limitinteger<int64>

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

cursorstring

The next_cursor of the previous page.

orderstring

desc (default) or asc.

sortstring

id (default, the creation order) or last_activity_at (the latest message, sent or received); ties are ordered by id.

includestring

total_count adds an exact count up to 10,000.

person_idId_Person

Threads with this person.

matches ^per_[0-9a-f]{32}$
connection_idId_Connection

Threads of this connection's identities.

matches ^con_[0-9a-f]{32}$
statusstring

open, snoozed or archived (a snooze that ended is open).

classificationstring

Threads with an inbound message of this classification.

Responses
200

A page of threads.

dataobject[]required

At most limit rows, 100 at most.

max items 100
Show properties
Array of object
campaign_idId_Campaign | null
Show properties
One of:
Id_Campaign
string
null
null
connection_idId_Connectionrequired
matches ^con_[0-9a-f]{32}$
created_atTimestamprequired
idId_Threadrequired
matches ^thr_[0-9a-f]{32}$
last_activity_atTimestamprequired
last_messageThreadMessage | null
Show properties
One of:
ThreadMessage
atTimestamprequired

When it was sent (or created, while it waits) or received.

classificationInboundClassification | null
Show properties
One of:
InboundClassification
string
null
null
directionDirectionrequired

Which way a thread's message went.

Allowed:outboundinbound
fromstring | null
idstringrequired

A message id (msg_…) for outbound mail, an inbound message id (inb_…) for inbound.

statestring | null

An outbound message's state.

subjectstring | null
textstring | null

The start of its text, when it has one of its own.

tostring[]required

The addresses an outbound message went to; empty for inbound mail.

null
null
messagesThreadMessages | null
Show properties
One of:
ThreadMessages
dataThreadMessage[]required

Oldest first.

max items 50
Show properties
Array of ThreadMessage
atTimestamprequired

When it was sent (or created, while it waits) or received.

classificationInboundClassification | null
Show properties
One of:
InboundClassification
InboundClassification
null
null
directionDirectionrequired

Which way a thread's message went.

Allowed:outboundinbound
fromstring | null
idstringrequired

A message id (msg_…) for outbound mail, an inbound message id (inb_…) for inbound.

statestring | null

An outbound message's state.

subjectstring | null
textstring | null

The start of its text, when it has one of its own.

tostring[]required

The addresses an outbound message went to; empty for inbound mail.

has_morebooleanrequired

Older messages exist.

null
null
participantsstring[]required

The addresses taking part.

person_idId_Person | null
Show properties
One of:
Id_Person
string
null
null
sender_identity_idId_SenderIdentityrequired
matches ^sid_[0-9a-f]{32}$
snoozed_untilTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
statusThreadStatusrequired

A thread's status as shown: snoozed turns open once its time passes.

Allowed:opensnoozedarchived
subjectstring | null
unreadbooleanrequired

Something arrived that nobody marked read.

updated_atTimestamprequired
versioninteger<int64>required
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 inbox: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/threads' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "data": [
    {
      "campaign_id": "cmp_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "connection_id": "con_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "created_at": "2019-08-24T14:15:22Z",
      "id": "thr_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "last_activity_at": "2019-08-24T14:15:22Z",
      "last_message": {
        "at": "2019-08-24T14:15:22Z",
        "classification": "human_reply",
        "direction": "outbound",
        "from": "string",
        "id": "string",
        "state": "string",
        "subject": "string",
        "text": "string",
        "to": [
          "string"
        ]
      },
      "messages": {
        "data": [
          {
            "at": "2019-08-24T14:15:22Z",
            "classification": "human_reply",
            "direction": "outbound",
            "from": "string",
            "id": "string",
            "state": "string",
            "subject": "string",
            "text": "string",
            "to": [
              "string"
            ]
          }
        ],
        "has_more": true
      },
      "participants": [
        "string"
      ],
      "person_id": "per_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "sender_identity_id": "sid_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
      "snoozed_until": "2019-08-24T14:15:22Z",
      "status": "open",
      "subject": "string",
      "unread": true,
      "updated_at": "2019-08-24T14:15:22Z",
      "version": 0
    }
  ],
  "meta": {
    "has_more": true,
    "next_cursor": "string",
    "total_count": 0,
    "total_count_capped": true
  }
}