A contact's referral link and counts, who referred them, and Grow's timeline events

GET

/api/v1/workspaces/{workspace}/contacts/{contact}/referrals

package main

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

func main() {

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

  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/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/referrals';
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/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/referrals \
  --header 'Authorization: Bearer <token>'

Permission: grow:view

API keys with grow:view can read a contact’s referral link and counts, so an app can show them to its users.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

contact

required

string format: uuid

Responses

200

application/json

object

events

required

Array<object>

object

required

string format: date-time

counted

required

integer format: int64

kind

required

string

Allowed values: joined counted milestone reward_sent partner_request

milestone

required

integer format: int64

partner

required

string

referrer

required

string

referrerId

required

string

reward

required

string

referredBy

object

countedAt

string format: date-time

countsOn

string format: date-time

linkId

required

string

programId

required

string

reason

required

string

referrer

required

string

referrerId

required

string

status

required

string

Allowed values: awaiting hold review counted not_counted

referrer

object

awaiting

required

integer format: int64

code

required

string

counted

required

integer format: int64

held

required

integer format: int64

inHold

required

integer format: int64

link

required

string

linkId

required

string

linkStatus

required

string

Allowed values: active paused

listName

required

string

milestones

required

Array<integer>

programId

required

string

rewards

required

Array<object>

object

milestone

required

integer format: int64

name

required

string

sentAt

string format: date-time

status

required

string

usedAt

string format: date-time

signups

required

integer format: int64

visits

required

integer format: int64

Example

{
  "events": [
    {
      "kind": "joined"
    }
  ],
  "referredBy": {
    "status": "awaiting"
  },
  "referrer": {
    "linkStatus": "active"
  }
}

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"
}