Skip to main content
GET
/
api
/
v1
/
publishing
/
subscribers
Get subscribers
curl --request GET \
  --url https://platform.plurex.io/api/v1/publishing/subscribers \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>'
[
  {
    "userHandle": "BobBuilder",
    "planIds": [
      "Starter"
    ]
  },
  {
    "userHandle": "AliceTrader",
    "planIds": [
      "Pro"
    ]
  }
]

Authorizations

​
X-API-KEY
string
header
required
​
X-API-SECRET
string
header
required

Response

200 - application/json

The state of all external subscribers

​
userHandle
string
required

The unique user handle that a user sets when they first create an account. Top of screen at https://plurex.io/#/settings/general

Example:

"BobBuilder"

​
planIds
string[]
required

The subscription plans that the user has access to.

Example:
["Starter"]
Example:
[
  {
    "userHandle": "BobBuilder",
    "planIds": ["Starter"]
  },
  {
    "userHandle": "AliceTrader",
    "planIds": ["Pro"]
  }
]