List Campaigns

cURL

curl --request GET \
  --url https://api-dev.withflock.com/campaigns \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-dev.withflock.com/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-dev.withflock.com/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.withflock.com/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.withflock.com/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "name": "<string>",
    "refereeLandingPageUrl": {},
    "termsUrl": {},
    "proposedRewardTrigger": {},
    "manualRewardTrigger": {},
    "inviteMessage": {},
    "isLive": true,
    "isDefault": true,
    "environment": "production",
    "copiedFromCampaignId": {},
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": {},
    "organizationId": "<string>",
    "applicationId": "<string>",
    "lastPingAt": {},
    "lastPingOrigin": {},
    "rewards": [
      {
        "name": {},
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": {},
        "organizationId": "<string>",
        "applicationId": "<string>",
        "limit": {},
        "type": "payout",
        "campaignId": "<string>",
        "description": {},
        "party": "referrer",
        "method": "paypal",
        "payoutAmount": {},
        "discountAmount": {},
        "discountPercentage": {},
        "discountDurationInMonth": {},
        "currency": "usd",
        "limitUnit": {},
        "limitInterval": {},
        "disabled": true
      }
    ],
    "emails": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": {},
        "organizationId": "<string>",
        "applicationId": "<string>",
        "message": "<string>",
        "type": "referrer:reward",
        "campaignId": "<string>",
        "subjectLine": "<string>",
        "buttonText": "<string>",
        "buttonColor": "<string>",
        "logoUrl": {},
        "logoSize": {}
      }
    ],
    "campaignPages": [
      {
        "path": "<string>",
        "id": "<string>",
        "isEmpty": true,
        "name": {},
        "placementId": {},
        "platform": {}
      }
    ],
    "faqs": [
      {}
    ],
    "platforms": [
      "mobile"
    ]
  }
]

GET

campaigns

cURL

curl --request GET \
  --url https://api-dev.withflock.com/campaigns \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-dev.withflock.com/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-dev.withflock.com/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.withflock.com/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.withflock.com/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "name": "<string>",
    "refereeLandingPageUrl": {},
    "termsUrl": {},
    "proposedRewardTrigger": {},
    "manualRewardTrigger": {},
    "inviteMessage": {},
    "isLive": true,
    "isDefault": true,
    "environment": "production",
    "copiedFromCampaignId": {},
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": {},
    "organizationId": "<string>",
    "applicationId": "<string>",
    "lastPingAt": {},
    "lastPingOrigin": {},
    "rewards": [
      {
        "name": {},
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": {},
        "organizationId": "<string>",
        "applicationId": "<string>",
        "limit": {},
        "type": "payout",
        "campaignId": "<string>",
        "description": {},
        "party": "referrer",
        "method": "paypal",
        "payoutAmount": {},
        "discountAmount": {},
        "discountPercentage": {},
        "discountDurationInMonth": {},
        "currency": "usd",
        "limitUnit": {},
        "limitInterval": {},
        "disabled": true
      }
    ],
    "emails": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": {},
        "organizationId": "<string>",
        "applicationId": "<string>",
        "message": "<string>",
        "type": "referrer:reward",
        "campaignId": "<string>",
        "subjectLine": "<string>",
        "buttonText": "<string>",
        "buttonColor": "<string>",
        "logoUrl": {},
        "logoSize": {}
      }
    ],
    "campaignPages": [
      {
        "path": "<string>",
        "id": "<string>",
        "isEmpty": true,
        "name": {},
        "placementId": {},
        "platform": {}
      }
    ],
    "faqs": [
      {}
    ],
    "platforms": [
      "mobile"
    ]
  }
]

Authorizations

Authorization

string

header

required

Query Parameters

environment

enum<string>

Filter campaigns by environment

Available options:

production,

test

isLive

boolean

Filter live campaigns only

isDefault

boolean

Filter default campaigns only

orderBy

object

Sorting criteria. Available options: createdAt

orderDirection

object

Sorting direction. Available options: asc, desc

Response

200 - application/json

name

string

required

refereeLandingPageUrl

object | null

required

termsUrl

object | null

required

proposedRewardTrigger

object | null

required

manualRewardTrigger

object | null

required

inviteMessage

object | null

required

isLive

boolean

required

isDefault

boolean

required

environment

enum<string>

required

Available options:

production,

test

copiedFromCampaignId

object | null

required

string

required

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

deletedAt

object | null

required

organizationId

string

required

applicationId

string

required

lastPingAt

object | null

required

lastPingOrigin

object | null

required

rewards

object[]

required

Show child attributes

emails

object[]

required

Show child attributes

campaignPages

object[]

required

Show child attributes

faqs

object[]

required

platforms

enum<string>[]

required

Available options:

mobile,

web

Campaigns

Checkpoints

Customers

Referrals

Rewards

Webhooks

List Campaigns

Authorizations

Query Parameters

Response