Subscribers

Get subscribers

GET https://api.sparkloop.app/v2/campaigns/:campaign_uuid/subscribers

Subscribers are ordered in descending order by created_at, meaning the first page shows the latest subscribers.

Query Parameters

Name	Type	Description
type	string	Type of subscribers you want to get. Default is all, allowed values are all, referrals, advocates.
campaign_uuid*	String	Referral campaign UUID, e.g. MF9a78983d1c.
expand	String	If you pass "campaigns" the response will include referral_programs data

200 Used query params ?page=2&per_page=2

{
  "subscribers": [
    {
      "uuid": "sub_4bc1056297",
      "email": "[e-mail]",
      "name": null,
      "ref_code": "c784ef4f",
      "referrer_code": null,
      "referred": true,
      "referral_status": "verified",
      "ip_address": null,
      "user_agent": null,
      "origin": "signup",
      "utm_source": null,
      "utm_campaign": null,
      "created_at": "2021-03-24T11:55:02.113Z"
    },
    {
      "uuid": "sub_869976268c",
      "email": "[e-mail]",
      "name": null,
      "ref_code": "d163ac6e",
      "referrer_code": null,
      "referred": false,
      "referral_status": "verified",
      "ip_address": null,
      "user_agent": null,
      "origin": "signup",
      "utm_source": null,
      "utm_campaign": null,
      "created_at": "2021-03-24T11:55:02.096Z"
    }
  ],
  "meta": {
    "per_page": 2,
    "page": 2,
    "total_pages": 3,
    "total_subscribers": 6
  }
}

Get a subscriber

GET https://api.sparkloop.app/v2/campaigns/:campaign_uuid/subscribers/:uuid

Returns a single subscriber by email address or UUID

Path Parameters

Name	Type	Description
uuid*	string	Subscriber's UUID or email address
campaign_uuid*	string	Referral campaign UUID, e.g. MF9a78983d1c.

Query Parameters

Name	Type	Description
expand	String	If you pass "campaigns" the response will include referral_programs data

200

{
  "subscriber": {
    "uuid": "sub_4bc1056297",
    "email": "[e-mail]",
    "name": null,
    "ref_code": "c784ef4f",
    "referrer_code": null,
    "referred": true,
    "referral_status": "verified",
    "ip_address": null,
    "user_agent": null,
    "origin": "signup",
    "utm_source": null,
    "utm_campaign": null,
    "created_at": "2021-03-24T11:55:02.113Z"
  }
}

404

Subscriber not found

{
    "error": "Subscriber sub_4bc10562d97 not found!"
}

Get referrals for a subscriber

GET https://api.sparkloop.app/v2/campaigns/:campaign_uuid/subscribers/:uuid/referrals

Get the referrals of a specific subscriber.

Subscribers are ordered descendingly by created_at, meaning the first page shows the latest subscribers.

Path Parameters

Name	Type	Description
uuid*	String	Subscriber's UUID or email address
campaign_uuid*	String	Referral campaign UUID, e.g. MF9a78983d1c.

Query Parameters

Name	Type	Description
per_page	integer	Number of subscribers returned in a single request. Default is 50, max is 200
page	integer	The page you want to get. Default is 1
expand	String	If you pass "campaigns" the response will include referral_programs data

200 Used query params ?page=2&per_page=3

{
    "subscribers": [
        {
            "uuid": "sub_4bc1056297",
            "email": "[e-mail]",
            "name": null,
            "ref_code": "c784ef4f",
            "referrer_code": null,
            "referrals_count": 0,
            "referred": true,
            "referral_status": "verified",
            "ip_address": null,
            "user_agent": null,
            "origin": "signup",
            "utm_source": null,
            "utm_campaign": null,
            "created_at": "2021-03-24T11:55:02.113Z"
        },
        {
            "uuid": "sub_869976268c",
            "email": "[e-mail]",
            "name": null,
            "ref_code": "d163ac6e",
            "referrer_code": null,
            "referrals_count": 0,
            "referred": true,
            "referral_status": "pending",
            "ip_address": null,
            "user_agent": null,
            "origin": "signup",
            "utm_source": null,
            "utm_campaign": null,
            "created_at": "2021-03-24T11:55:02.096Z"
        },
        {
            "uuid": "sub_d4795d06e6",
            "email": "[e-mail]",
            "name": null,
            "ref_code": "57b1fae2",
            "referrer_code": null,
            "referrals_count": 0,
            "referred": true,
            "referral_status": "rejected",
            "ip_address": null,
            "user_agent": null,
            "origin": "api",
            "utm_source": null,
            "utm_campaign": null,
            "created_at": "2021-03-24T11:55:02.066Z"
        }
    ],
    "meta": {
        "per_page": 3,
        "page": 2,
        "total_pages": 12,
        "total_subscribers": 36
    }
}