Skip to main content
GET
Active subscribers

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Query Parameters

limit
integer
default:10

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

Required range: 1 <= x <= 20
cursor
string | null

Cursor from the previous response. Send it to get the next page

query
string

Text to search for

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
spentDateStart
string

Start of total-spend date window

spentDateEnd
string

End of total-spend date window

tipAmount
number | null

Tip amount filter

Required range: x >= 0
durationMonths
integer

Subscription duration in months

Required range: x > 0
isInactive
enum<string>

Filter by inactive subscription state

Available options:
0,
1,
true,
false
hasRecommenders
enum<string>

Filter by recommender activity

Available options:
0,
1,
true,
false

Response

Successful response

items
object[]
required
page
object
required