A referral program with its settings

GET

/api/v1/workspaces/{workspace}/grow/referrals/{program}

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"

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

  req.Header.Add("Authorization", "Bearer <token>")

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

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

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Permission: grow:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

program

required

string format: uuid

Responses

200

application/json

object

announcedIn

required

string

awaiting

required

integer format: int64

counting

required

object

burst

required

object

required

boolean

threshold

required

integer format: int64

>= 1 <= 1000

disposable

required

boolean

holdDays

required

integer format: int64

Allowed values: 0 3 7 14 30

left

required

boolean

numbered

required

boolean

sameIp

required

boolean

sharedIp

required

object

required

boolean

threshold

required

integer format: int64

>= 1 <= 1000

emails

required

object

milestones

required

integer format: int64

required

integer format: int64

replyTo

required

string

senderId

required

string

held

required

integer format: int64

heldOldest

string format: date-time

helpers

required

object

connect

required

Array<string>

earn

required

Array<string>

edit

required

Array<string>

export

required

Array<string>

review

required

Array<string>

required

string

inHold

required

integer format: int64

leaderboard

required

object

string format: date-time

required

string

required

boolean

periods

required

Array<string>

<= 2 items

Allowed values: month all

rows

required

integer format: int64

Allowed values: 5 10 25

url

required

string

linkExample

required

string

linkHost

required

string

links

required

integer format: int64

listId

required

string

listName

required

string

pages

required

object

hubIntro

required

string

<= 600 characters

inviteHeadline

required

string

<= 200 characters

inviteText

required

string

<= 600 characters

shareButtons

required

Array<string>

<= 5 items

Allowed values: copy email x linkedin whatsapp

shareMessage

required

string

<= 500 characters

senders

required

Array<object>

object

default

required

boolean

email

required

string

required

string

name

required

string

verified

required

boolean

setupSavedAt

string format: date-time

setupSavedBy

required

string

setupStep

required

integer format: int64

startedAt

string format: date-time

startedBy

required

string

status

required

string

Allowed values: off on

statusAt

string format: date-time

statusBy

required

string

subscribers

required

integer format: int64

updatedAt

required

string format: date-time

Example

{
  "counting": {
    "holdDays": 0
  },
  "leaderboard": {
    "periods": [
      "month"
    ],
    "rows": 5
  },
  "pages": {
    "shareButtons": [
      "copy"
    ]
  },
  "status": "off"
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}