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.

Endpoint

EndpointMethod
/api/admin/marketing/subscribers/{id}GET

Details

  • Requires an admin Bearer token in the Authorization header.
  • customerId and customerName resolve when the subscriber's email matches a registered customer; otherwise they are null.
  • An unknown id returns a 404.

Response fields

FieldTypeNotes
idintNumeric id
emailstringSubscriber email address
channelobjectThe channel the subscription belongs to — { id, code, name }. Detail-only (null on list rows)
customerIdintLinked customer id, or null
customerNamestringLinked customer name, or null
isSubscribedbooltrue subscribed / false unsubscribed
createdAtstringCreation timestamp
updatedAtstringLast-update timestamp

Released under the MIT License.