Skip to content
ReputeCastReputeCast Docs

The milestones with their rewards, health and emails, the files and the To fulfill queue

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

Permission: grow:view

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

program
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
files
required
Array<object>
object
contentType
required
string
downloads
required
integer format: int64
id
required
string
name
required
string
size
required
integer format: int64
uploadedAt
required
string format: date-time
uploadedBy
required
string
helpers
required
object
connect
required
Array<string>
earn
required
Array<string>
edit
required
Array<string>
export
required
Array<string>
review
required
Array<string>
items
required
Array<object>
object
askAddress
required
boolean
codesAlertBelow
required
integer format: int64
codesLeft
required
integer format: int64
codesUploaded
required
integer format: int64
count
required
integer format: int64
couponOfferId
required
string
couponOfferName
required
string
couponValidDays
required
integer format: int64
downloadUrl
required
string
email
required
object
emailId
required
string
on
required
boolean
savedAt
string format: date-time
subject
required
string
versions
required
integer format: int64
file
object
contentType
required
string
downloads
required
integer format: int64
id
required
string
name
required
string
size
required
integer format: int64
uploadedAt
required
string format: date-time
uploadedBy
required
string
health
required
object
codesLeft
required
integer format: int64
failures
required
integer format: int64
kind
required
string
Allowed values: healthy codes_low codes_out webhook_failing stripe_missing file_missing
lastStatus
required
integer format: int64
runOutDays
number format: double
status
required
string
Allowed values: ok warn bad
waiting
required
integer format: int64
id
required
string
image
object
height
required
integer format: int64
id
required
string
name
required
string
size
required
integer format: int64
url
required
string
width
required
integer format: int64
rewardDescription
required
string
rewardName
required
string
stats
required
object
failed
required
integer format: int64
reached
required
integer format: int64
sent
required
integer format: int64
toFulfill
required
integer format: int64
used
required
integer format: int64
waiting
required
integer format: int64
waitingCodes
required
integer format: int64
type
required
string
Allowed values: download codes manual coupon webhook
webhookCalledAt
string format: date-time
webhookSecretSet
required
boolean
webhookStatus
integer format: int64
webhookUrl
required
string
listName
required
string
programId
required
string
sender
required
string
showAddresses
required
boolean
stripe
required
object
account
required
string
connected
required
boolean
offers
required
Array<object>
object
appliesTo
required
string
discount
required
string
id
required
string
issued
required
integer format: int64
name
required
string
redeemed
required
integer format: int64
toFulfill
required
Array<object>
object
address
object
city
required
string
<= 200 characters
country
required
string
<= 100 characters
name
required
string
<= 200 characters
street
required
string
<= 300 characters
contactId
required
string
email
required
string
milestone
required
integer format: int64
reachedAt
required
string format: date-time
referrer
required
string
rewardId
required
string
rewardName
required
string

Example 

{
  "items": [
    {
      "health": {
        "kind": "healthy",
        "status": "ok"
      },
      "type": "download"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0