Referral Hero Documentation
Getting StartedFeaturesIntegration
  • Introduction to ReferralHero
  • Getting Started
    • Quickstart
    • Creating a New Campaign
      • Choose a Campaign Type
      • Set Your Goals
      • Define a Unique Identifier
      • Set Up Integrations
      • Set Up Automations
      • Configure Options
  • Features
    • Subscribers
      • Types Of Subscribers
  • Integrations
    • Overview
    • Embeddable Widgets
      • Advocate Dashboard Widget
      • Referral Signup Widget
      • Referral Welcome Banner
      • Sharing Widget
      • Floating Button
      • Customize the Widgets
    • Javascript Web API
      • Getting Started
      • Configuration File
      • Callbacks
      • Add a Subscriber
      • Add a Pending Referral
      • Track multi-step conversion events
      • Track Transaction
      • Identify a Subscriber
      • Identify a Referrer
      • Generate Dashboard Widget
      • Generate Sharing-Screen
    • React JS
    • Platform Specific Integration
      • Shopify
      • Webflow
      • WordPress
    • Mobile SDK's
      • React Native
        • Getting Started
        • Mobile App Testing in Development Mode
    • REST API
      • Lists
        • 🟠POST lists
        • 🟢GET lists
        • 🟢GET lists/:uuid/leaderboard
        • 🟢GET lists/:uuid/bonuses
    • API Tutorials
Powered by GitBook
On this page
  1. Integrations
  2. REST API
  3. Lists

GET lists

PreviousPOST listsNextGET lists/:uuid/leaderboard

Last updated 5 months ago

Retrieve all lists

GET

Get all the lists/campaigns in your account. Results are paginated (10 results per page). Only active lists will be retrieved.

Path Parameters

Name
Type
Description

api_token

string

Your API Token

page

string

Page you want to jump to. By default 1.

Response

{
    "status": "ok",
    "data": {
        "response": "lists_retrieved",
        "lists": [
            {
                "uuid": "MF521c3aade8",
                "name": "My amazing sweepstake",
                "created_at": 1731936007,
                "subscribers": 0
            },
            {
                "uuid": "MF41c1858b40",
                "name": "Shopify",
                "created_at": 1725628341,
                "subscribers": 40
            },
            ...
        ],
        "pagination": {
            "total_pages": 1,
            "current_page": 1,
            "per_page": 10,
            "total_objects": 7
        }
    },
    "calls_left": 1000,
    "timestamp": 1731937134
}
🟢
https://app.referralhero.com/api/v2/lists