List subscriptions

Get a paginated list of people you’re subscribed to/following. Use the type query parameter to filter: ‘all’ (default), ‘active’, or ‘expired’.

Permission Required: subscriptions:read

GET /v2/access/subscriptions

List subscriptions

cURL

curl --request GET \
  --url https://api.ofauth.com/v2/access/subscriptions \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'

200

{
  "list": [
    {
      "id": 123,
      "username": "<string>",
      "name": "<string>",
      "avatar": "<string>",
      "lists": [
        {
          "id": "<string>",
          "type": "<string>",
          "name": "<string>"
        }
      ],
      "subscribedAt": "<string>",
      "expiredAt": "<string>",
      "renewedAt": "<string>",
      "isActive": true,
      "subscriptionPrice": 123,
      "avatarThumbs": {
        "c50": "<string>",
        "c144": "<string>"
      },
      "tipsSumm": 123,
      "subscribesSumm": 123,
      "messagesSumm": 123,
      "postsSumm": 123,
      "streamsSumm": 123,
      "totalSumm": 123
    }
  ],
  "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

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

filter · object

Advanced filters

Show child attributes

type · enum<string> · default: active

Subscription status filter

Available options: all, active, expired

Response

200

application/json

Successful response

list · object[] · required

Show child attributes

hasMore · boolean · required