Skip to content

Who on a list a paid-only campaign reaches: everyone, paid members only or free subscribers only

GET
/api/v1/workspaces/{workspace}/earn/audience
curl --request GET \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/earn/audience \
--header 'Authorization: Bearer <token>'

Permission: campaigns:edit

Counts only. Drafting a paid-only campaign needs campaigns:edit, like any draft.

workspace
required

Workspace slug

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

Workspace slug

list

The campaign’s list

string format: uuid

The campaign’s list

tier

The lowest tier of paid members; empty for any paid tier

string

The lowest tier of paid members; empty for any paid tier

OK

Media typeapplication/json
object
complimentary
required
integer format: int64
connected
required
boolean
everyone
required
integer format: int64
free
required
integer format: int64
gift
required
integer format: int64
leftOut
required
object
inactive
required
integer format: int64
notOnList
required
integer format: int64
suppressed
required
integer format: int64
unsubscribed
required
integer format: int64
paid
required
integer format: int64
pastDue
required
integer format: int64
tiers
required
Array<object>
object
id
required
string
name
required
string
short
required
string
top
required
boolean
trialing
required
integer format: int64
withAccess
required
integer format: int64

Example generated

{
"complimentary": 1,
"connected": true,
"everyone": 1,
"free": 1,
"gift": 1,
"leftOut": {
"inactive": 1,
"notOnList": 1,
"suppressed": 1,
"unsubscribed": 1
},
"paid": 1,
"pastDue": 1,
"tiers": [
{
"id": "example",
"name": "example",
"short": "example",
"top": true
}
],
"trialing": 1,
"withAccess": 1
}

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