Skip to content

Newsletter Subscriber Detail

Returns a single newsletter subscriber with its full field set — the data behind the admin Marketing → Communications → Newsletter Subscribers view screen.

TIP

New here? Read the Newsletter Subscribers overview for what a subscriber is and how its fields behave.

Operation

OperationTypePurpose
adminMarketingSubscriberQueryFetch one newsletter subscriber by id

Details

  • Requires an admin Bearer token in the Authorization header.
  • Pass the subscriber's IRI (e.g. /api/admin/marketing/subscribers/26) as the id argument; _id in the response is the numeric id.

Fields

FieldTypeNotes
idIDThe subscriber's IRI
_idIntNumeric id
emailStringSubscriber email address
channelObjectThe channel the subscriber opted in on — sub-select id, _id, code, name. Detail-only (null on list rows)
customerIdIntLinked customer id, or null for a guest subscriber
customerNameStringLinked customer name, or null
isSubscribedBooleantrue subscribed / false unsubscribed
createdAtStringCreation timestamp
updatedAtStringLast-update timestamp

Released under the MIT License.