Naar de inhoud
NLEN
Open Nexym

List subscribers

GET
/api/connect/subscribers
curl --request GET \
  --url 'https://app.nexym.nl/api/connect/subscribers?per_page=50&page=1' \
  --header 'Authorization: Bearer <token>'

A page of mailing-list subscribers for the key’s project. No relations are loaded.

Requires subscribers: read (or write).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
per_page
integer
default: 50 >= 1 <= 200

Records per page. Values above 200 are silently clamped to 200. The value is not otherwise validated, so send a sensible positive integer.

page
integer
default: 1 >= 1

1-based page number.

Responses

Section titled “Responses”

200

Section titled “200”

A page of subscribers.

Media typeapplication/json
object
current_page
required
integer
data
required
Array<object>
object
first_page_url
required
string format: uri
from
required

Index of the first record on this page, or null on an empty page.

integer | null
last_page
required
integer
last_page_url
required
string format: uri
links
required
Array<object>

One entry of the paginator’s rendered link list.

object
url
string | null format: uri
label
string
page
integer | null
active
boolean
next_page_url
required
string | null format: uri
path
required
string format: uri
per_page
required
integer
prev_page_url
required
string | null format: uri
to
required
integer | null
total
required
integer
data
required
Array<object>

One mailing-list subscription.

object
id
integer
project_id
integer
reference
string
email
string | null format: email
customer_reference
string | null
location_reference
string | null
status

The source’s state for the subscription, e.g. subscribed or unsubscribed.

string | null
is_subscribed
boolean | null
subscribed_at
string | null format: date-time
unsubscribed_at
string | null format: date-time
meta

Free-form store for fields the universal schema does not define for everybody: a connector’s declared extension fields and a project’s own customer fields, each under its own name.

object | null
source_connection_id
integer | null
created_at
string | null format: date-time
updated_at
string | null format: date-time

Example 

{
  "current_page": 1,
  "first_page_url": "https://app.nexym.nl/api/connect/orders?page=1",
  "from": 1,
  "last_page": 7,
  "last_page_url": "https://app.nexym.nl/api/connect/orders?page=7",
  "links": [
    {
      "url": "https://app.nexym.nl/api/connect/orders?page=2",
      "label": "2",
      "page": 2,
      "active": false
    }
  ],
  "next_page_url": "https://app.nexym.nl/api/connect/orders?page=2",
  "path": "https://app.nexym.nl/api/connect/orders",
  "per_page": 50,
  "prev_page_url": null,
  "to": 50,
  "total": 318,
  "data": [
    {
      "id": 7711,
      "project_id": 3,
      "reference": "SUB-7711",
      "email": "ops@example.com",
      "customer_reference": "CUST-0099",
      "location_reference": "WH-MAIN",
      "status": "subscribed",
      "is_subscribed": true,
      "subscribed_at": "2026-05-02T08:14:00.000000Z",
      "unsubscribed_at": null,
      "meta": {
        "service_code": "INSTALL-STD"
      },
      "source_connection_id": 7,
      "created_at": "2026-05-02T08:14:01.000000Z",
      "updated_at": "2026-09-01T07:00:00.000000Z"
    }
  ]
}

401

Section titled “401”

No key, a key that does not match, a revoked key, or an expired one. The body says which, and nothing else — an unusable key is never described further.

Media typeapplication/json

Every error this API returns carries a single human-readable message.

object
message
required
string

Examples

No bearer token, or one too short to hold a prefix

{
  "message": "Missing or invalid API key."
}

403

Section titled “403”

The key is valid but its abilities do not cover this resource at this right.

Media typeapplication/json

Every error this API returns carries a single human-readable message.

object
message
required
string

Examples

{
  "message": "This API key lacks read access to orders."
}

429

Section titled “429”

The per-minute rate limit was exceeded. The limit is 120 requests per minute by default (CONNECT_API_RATE_PER_MIN), counted per API key — or per IP address for a request that never authenticated.

Media typeapplication/json

Every error this API returns carries a single human-readable message.

object
message
required
string

Examples

Examplelimited
{
  "message": "Too many requests — slow down."
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds until the limit resets.

X-RateLimit-Limit
integer

Requests allowed per minute.

X-RateLimit-Remaining
integer

Requests left in the current window.