Smart Links

List Smart Links

Changed on

List all Smart Links

get/api/smart-links

Request

  • Base URL
    https://app.onlyfansapi.com
  • URL
    https://app.onlyfansapi.com/api/smart-links
  • Auth
    HTTP bearer

Query parameters

limitinteger

The number of Smart Links to return. Default 50. Must be at least 1. Must not be greater than 1000.

Example:50
offsetinteger

The offset used for pagination. Default 0. Must be at least 0.

namestring nullable

Filter Smart Links by name. Must not be greater than 255 characters.

Example:Instagram
account_idsstring nullable

Comma-separated account prefixed IDs to include.

Example:acct_abc123,acct_def456
pixel_idsstring nullable

Comma-separated ad platform Pixel IDs to include.

Example:1,2
filterobject
filter.tagsstring[]

Must not be greater than 50 characters.

[
  "xwhnqqemqhwdw"
]

Response

Success

Example response

{
  "data": [
    {
      "id": "01JCZWQJZXQJZXQJZXQJZXQJZX",
      "platform": "onlyfans",
      "creator_id": "123456789",
      "creator_username": "examplecreator",
      "name": "Instagram Bio Link",
      "link_type": "free_trial",
      "traffic_redirect_url": "https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX",
      "event_source_url": null,
      "free_trial_days": 7,
      "clicks_count": 150,
      "conversions_count": 45,
      "subscribers_count": 30,
      "spenders_count": 12,
      "revenue": "1250.00",
      "cost": {
        "inputMode": null,
        "inputValue": null,
        "perSub": null,
        "perClick": null,
        "perPromo": null,
        "subscriberSourceCount": 30,
        "clickSourceCount": 150
      },
      "account": {
        "id": "acct_XXXXXXXX",
        "display_name": "Example Creator",
        "username": "examplecreator"
      },
      "created_at": "2025-01-15T10:30:00+00:00",
      "updated_at": "2025-01-15T10:30:00+00:00"
    },
    {
      "id": "01JCZWQJZXQJZXQJZXQJZXQJZY",
      "platform": "fanvue",
      "creator_id": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "creator_username": "examplefanvue",
      "name": "Twitter Promo",
      "link_type": "tracking_link",
      "traffic_redirect_url": "https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZY",
      "event_source_url": null,
      "free_trial_days": null,
      "clicks_count": 320,
      "conversions_count": 89,
      "subscribers_count": 65,
      "spenders_count": 24,
      "revenue": "2450.50",
      "cost": {
        "inputMode": null,
        "inputValue": null,
        "perSub": null,
        "perClick": null,
        "perPromo": null,
        "subscriberSourceCount": 65,
        "clickSourceCount": 320
      },
      "account": {
        "id": "fanvue_acct_XXXXXXXX",
        "display_name": "Example Fanvue Creator",
        "username": null
      },
      "created_at": "2025-01-10T08:15:00+00:00",
      "updated_at": "2025-01-10T08:15:00+00:00"
    }
  ],
  "_meta": {
    "_credits": {
      "used": 0,
      "balance": 999999985,
      "note": "Free endpoint"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 10000000,
      "limit_day": 50000,
      "remaining_minute": 9999998,
      "remaining_day": 49988
    }
  }
}

Changes

    • info

      added the optional property // to the response with the status

    • warning

      deleted the query request parameter meta_pixel_ids

    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter filter.tags

    • info

      added the new optional query request parameter pixel_ids

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status