Skip to main content
GET
List subscriptions

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

limit
integer
default:10

Number of subscriptions to return (1-50)

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

Number of items to skip (default: 0)

Required range: x >= 0
query
string

Search/filter text

Maximum string length: 100
promotionId
string | null

Filter by promotion ID

trialLinkId
string | null

Filter by trial link ID

isOnline
boolean

Filter to online or offline creators

minSpend
number | null

Minimum total spend

Required range: x >= 0
duration
string | null

Subscription duration filter

hasTips
boolean

Filter to subscriptions with or without tips

type
enum<string>
default:active

Subscription status filter

Available options:
all,
active,
expired

Response

Successful response

list
object[]
required
hasMore
boolean
required