Sign in
Smart Links

List Smart Links

List all Smart Links

get/api/smart-links

Query parameters

limitinteger

The number of Smart Links to return. Default 50

Example:50

The number of Smart Links to return. Default 50

offsetinteger

The offset used for pagination. Default 0

The offset used for pagination. Default 0

namestring

Filter Smart Links by name.

Example:Instagram

Filter Smart Links by name.

account_idsstring

Comma-separated account prefixed IDs to include.

Example:acct_abc123,acct_def456

Comma-separated account prefixed IDs to include.

meta_pixel_idsstring

Comma-separated Meta Pixel IDs to include.

Example:1,2

Comma-separated Meta Pixel IDs to include.

Request body

limitinteger

Must be at least 1. Must not be greater than 1000.

offsetinteger

Must be at least 0.

namestring nullable

Must not be greater than 255 characters.

account_idsstring nullable
meta_pixel_idsstring nullable

Example request

{
  "limit": 2,
  "offset": 12,
  "name": "lbeytmaoszcbnlkx",
  "account_ids": "voluptatibus",
  "meta_pixel_ids": "aut"
}

Response

Success

Example response

{
  "data": [
    {
      "id": "01JCZWQJZXQJZXQJZXQJZXQJZX",
      "name": "Instagram Bio Link",
      "link_type": "free_trial",
      "traffic_redirect_url": "https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX",
      "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",
      "name": "Twitter Promo",
      "link_type": "tracking_link",
      "traffic_redirect_url": "https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZY",
      "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": "acct_XXXXXXXX",
        "display_name": "Example Creator",
        "username": "examplecreator"
      },
      "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