Skip to main content
GET
List subscribers

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
isOnline
enum<string>

Filter by online status

Available options:
0,
1,
true,
false
minSpend
number | null

Minimum total spend

Required range: x >= 0
tipAmount
number | null

Tip amount filter

Required range: x >= 0
durationMonths
integer

Subscription duration in months

Required range: x > 0
limit
integer
default:10

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

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

Number of items to skip (default: 0)

Required range: x >= 0

Response

Successful response

list
object[]
required

Subscribers returned for this page.

hasMore
boolean
required

Whether another page is available.