Skip to contentDevelopersPrezly website
Subscriptions

List newsroom subscriptions

List a newsroom’s subscribers and inspect their effective subscription state.

Personal token scopes: sites:read + contacts:read. Your account must also have access to the requested data. Authentication

Returns subscriptions with subscriber identities, is_active, and pagination. This administrative data belongs on your server.

Read the guide

GET
/newsrooms/{newsroom_id}/subscriptions

List newsroom subscriptions, including inactive entries. is_active combines the newsroom cancellation and the account-wide opt-out. Subscriber contacts are included only when the caller has the contact permission. Supports search and pagination; newest subscriptions are the default order.

Personal access tokens: sites:read and contacts:read. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Path Parameters

newsroom_id*string

Newsroom UUID or ID

Length1 <= length

Query Parameters

search?string

Keyword to use for full text search

sort?string
Match[-+]?(\w+\.)*\w+
offset?integer

Number of records to skip (for pagination)

limit?integer

Number of records to fetch

Range1 <= value <= 1000
Default20

Response Body

OK

application/json
  1. response
subscriptions*array<>
sort*string
pagination*
Example Request
curl -X GET 'https://api.prezly.com/v2/newsrooms/string/subscriptions'
Example Response200
{  "subscriptions": [    {      "subscriber": {        "id": "string",        "email_address": "string",        "first_name": "string",        "last_name": "string",        "is_demo": true,        "contacts": [          {            "id": 0,            "contact_type": "person",            "display_name": "string",            "function_name": "string",            "avatar_url": "http://example.com",            "is_deleted": true,            "links": {              "api": "http://example.com",              "view": "http://example.com"            }          }        ]      },      "is_active": true,      "created_at": "2019-08-24T14:15:22Z",      "culture": {        "code": "en",        "name": "string",        "direction": "ltr",        "language_code": "en",        "native_name": "string"      }    }  ],  "sort": "string",  "pagination": {    "offset": 0,    "limit": 0,    "matched_records_number": 0,    "total_records_number": 0  }}