Skip to main content
GET
/
campaigns
List campaigns
curl --request GET \
  --url https://api.referralful.com/v1/campaigns \
  --header 'Authorization: Basic <encoded-value>'
{
  "pagination": {
    "previous_page": 123,
    "current_page": 123,
    "next_page": 123,
    "count": 123,
    "limit": 123,
    "total_pages": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "object": "campaign",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "url": "<string>",
      "private": true,
      "commission_percent": 123,
      "commission_amount_cents": 123,
      "commission_currency": "<string>",
      "minimum_payout_cents": 123,
      "days_before_referrals_expire": 123,
      "days_before_commissions_are_due": 123,
      "max_commissions": 123,
      "max_commission_period_in_months": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Use your API secret as the username, with an empty password.

Query Parameters

page
integer
default:1
limit
integer
default:25
Required range: x <= 100

Response

200 - application/json

OK

pagination
object
data
object[]