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

Lists

Your ReferralHero list, also referred to as your campaign, is the centralized location where you store and manage all of your subscribers. Each subscriber is tied to a single campaign and cannot be transferred to another list. This ensures organized and consistent subscriber management.

Name
Type
Description

name

string

The campaign name

subscribers

integer

The total subscribers count

uuid

string

The unique identifier of the campaign

created_at

timestamp

Unix timestamp (expressed in UTC) of when the list has been created.

PreviousREST APINextPOST lists

Last updated 5 months ago