Earn › Gifts: the numbers, the gift options and page, the gift emails and the gifts that need a look

GET

/api/v1/workspaces/{workspace}/earn/gifts

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/gifts"

  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/earn/gifts';
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/earn/gifts \
  --header 'Authorization: Bearer <token>'

Permission: earn:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Responses

200

application/json

object

canEdit

required

boolean

canManage

required

boolean

categoryKind

required

string

categoryName

required

string

connected

required

boolean

currency

required

string

emails

required

Array<object>

object

draftVersion

required

integer format: int64

email

required

string

Allowed values: gift_purchased gift_received gift_ending

liveVersion

required

integer format: int64

name

required

string

status

required

string

Allowed values: live draft missing

template

required

string

templateId

string

ending

object

buyer

required

string

due

required

string format: date-time

inPerson

required

boolean

recipient

required

string

templateId

string

fromEmail

required

string

fromName

required

string

helpers

required

Array<string>

listNames

required

Array<string>

mode

required

string

Allowed values: live test ""

needsLook

required

Array<object>

object

accessEnds

string format: date-time

amountCents

required

integer format: int64

boughtAt

required

string format: date-time

buyer

required

string

buyerEmail

required

string

currency

required

string

deliverAt

string format: date-time

deliveredAt

string format: date-time

emailStatus

required

string

required

string

inPerson

required

boolean

linkExpiresAt

string format: date-time

months

required

integer format: int64

paymentUrl

string

recipientEmail

required

string

recipientName

required

string

redeemedAt

string format: date-time

redeemedBy

string

refundedAt

string format: date-time

remindAt

string format: date-time

remindedAt

string format: date-time

short

required

string

status

required

string

Allowed values: scheduled not_redeemed redeemed expired refunded

tier

required

string

timezone

required

string

numbers

required

object

byMonths

required

Array<object>

object

count

required

integer format: int64

months

required

integer format: int64

delivered

required

integer format: int64

nextAt

string format: date-time

nextTimezone

string

redeemed

required

integer format: int64

scheduled

required

integer format: int64

sold

required

integer format: int64

soldCents

required

integer format: int64

waiting

required

integer format: int64

withAccess

required

integer format: int64

options

required

Array<object>

object

amountCents

required

integer format: int64

currency

required

string

required

string

months

required

integer format: int64

short

required

string

sold

required

integer format: int64

soldCents

required

integer format: int64

tier

required

string

tierId

required

string

page

required

object

changedAt

string format: date-time

changedBy

string

host

required

string

linkMonths

required

integer format: int64

required

boolean

url

required

string

provider

required

string

routePrimary

required

string

tiers

required

Array<object>

object

required

string

monthlyCents

required

integer format: int64

name

required

string

short

required

string

yearlyCents

required

integer format: int64

Example

{
  "emails": [
    {
      "email": "gift_purchased",
      "status": "live"
    }
  ],
  "mode": "live",
  "needsLook": [
    {
      "status": "scheduled"
    }
  ]
}

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