Skip to content

Get subscribers

Get subscribers from a subscriber list

Endpoint URI

1
GET https://services.ownpage.fr/v1/newsletters/lists/LIST_ID/subscribers?status=STATUS&offset=OFFSET&count=COUNT&search=EMAIL

Endpoint parameters

  • LIST_ID : the email list you want to read

Headers

  • X-Ownpage-Client-Token : a valid token

Query string parameters

  • STATUS (values subscribed|unsubscribed|all, default subscribed): filter to get only the subscribed users (subscribed) or the unsubscribed ones (unsubscribed) or all subscribers (all)
  • OFFSET (default 0): Initial position in the list
  • COUNT (default 1 000, max 10 000): number of subscribers to return
  • SEARCH: filter to get only the matching email addresses.

Response (JSON)

Returns an array of subscribers. Each subscriber can contain have these fields :

  • email: the user's email address
  • guid: the unique identifier of this user
  • data_*: additional data you may have attached to the user. Example : data_firstname
  • subscribed: (true|false) the status subscribed/unsubscribed.
  • subscribed_at: date of subscription
  • unsubscribed_at: date of unsubscription (if unsubscribed)
  • unsubscribed_cause: unsubscription cause (READER: reader decision, PUBLISHER: publisher decision), used when subscribed = false. Default value is READER
  • last_sent_at: last email sent to this user
  • last_open_at: last email opened by this user
  • last_click_at: last click made by this user in a newsletter
  • send_count: number of emails sent to this user
  • open_count: number of emails opened by this user
  • click_count: number of emails the user clicked in

Example

We get all subscribed users of our list with id #123

1
curl -H "X-Ownpage-Client-Token:TOKEN" https://services.ownpage.fr/v1/newsletters/lists/123/subscribers

Response example:

1
2
3
4
[
    { "email" : "email1@domaine.fr", "guid": "utilisateur1", "subscribed" : true, "subscribed_at": "2016-..." },
    { "email" : "email2@domaine.fr", "guid": "utilisateur2", "subscribed" : true, "subscribed_at": "2016-..." }
]

Comments