Skip to main content
GET
/
v2
/
access
/
subscribers
List subscribers
curl --request GET \
  --url https://api-next.ofauth.com/v2/access/subscribers \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "list": [
    {
      "id": 123,
      "name": "<string>",
      "username": "<string>",
      "displayName": "<string>",
      "isVerified": true,
      "avatar": "<string>",
      "avatarThumbs": {
        "c50": "<string>",
        "c144": "<string>"
      },
      "lastSeen": "<string>",
      "subscription": {
        "isActive": true,
        "isExpired": true,
        "subscribedAt": "<string>",
        "expiresAt": "<string>",
        "renewedAt": "<string>",
        "price": 123,
        "regularPrice": 123,
        "discountPercent": 123,
        "discountPeriod": 123,
        "discountStartedAt": "<string>",
        "discountFinishedAt": "<string>",
        "history": [
          {
            "id": 123,
            "startDate": "<string>",
            "expireDate": "<string>",
            "price": 123,
            "regularPrice": 123,
            "discount": 123,
            "type": "<string>",
            "action": "<string>",
            "isCurrent": true
          }
        ]
      },
      "spending": {
        "total": 123,
        "tips": 123,
        "subscriptions": 123,
        "messages": 123,
        "posts": 123,
        "streams": 123
      },
      "isRestricted": true,
      "isBlocked": true,
      "capabilities": {
        "canRestrict": true,
        "canBlock": true,
        "canReport": true,
        "canUnsubscribe": true,
        "canReceiveMessages": true,
        "canSendTrial": true
      },
      "lists": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    }
  ],
  "hasMore": true
}

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Query Parameters

query
string

Search/filter text

Maximum string length: 100
filter
object

Advanced filters

type
default:active

Subscriber type filter

Available options:
all,
active,
expired
startDate
string

Filter subscribers from this date (for type=latest)

endDate
string

Filter subscribers until this date (for type=latest)

latestType
enum<string>
default:total

Sub-filter for latest: total, new subscribers, or renewals only

Available options:
total,
new,
renewals
limit
integer
default:10

Number of items to return (1-100, default: 10)

Required range: 1 <= x <= 100
offset
integer | null
default:0

Number of items to skip (default: 0)

Required range: x >= 0

Response

Successful response

list
object[]
required
hasMore
boolean
required