Skip to content
ReputeCastReputeCast Docs

An import of paid members: its columns, matches, choices and progress

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

Permission: earn: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

id
required

Id

string format: uuid

Id

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
account
required
string
active
object
byCustomer
required
integer format: int64
byEmail
required
integer format: int64
count
required
integer format: int64
examples
required
Array<object>
object
amountCents
integer format: int64
currency
string
customer
string
email
required
string
endedAt
string format: date-time
name
string
paidThrough
string format: date-time
period
string
row
required
integer format: int64
tier
string
columns
required
Array<object>
object
example
required
string
name
required
string
usedAs
required
string
Allowed values: email customer plan paid_through name ""
conflicts
required
Array<object>
object
candidates
required
Array<object>
object
amountCents
integer format: int64
created
required
string format: date-time
currency
string
customer
required
string
period
string
since
string format: date-time
status
string
tier
string
chosen
string
email
required
string
row
required
integer format: int64
createdAt
required
string format: date-time
createdBy
string
decisions
required
object
conflicts
object
key
additional properties
string
noSubscription
required
string
default: complimentary
Allowed values: complimentary free skip
prices
object
key
additional properties
object
legacy
required
boolean
tierId
required
string
sendWelcome
required
boolean
done
required
integer format: int64
ended
object
byCustomer
required
integer format: int64
byEmail
required
integer format: int64
count
required
integer format: int64
examples
required
Array<object>
object
amountCents
integer format: int64
currency
string
customer
string
email
required
string
endedAt
string format: date-time
name
string
paidThrough
string format: date-time
period
string
row
required
integer format: int64
tier
string
error
string
fileName
required
string
fileSize
required
integer format: int64
finishedAt
string format: date-time
id
required
string
lists
required
Array<object>
object
id
required
string
name
required
string
mode
required
string
Allowed values: live test
none
object
byCustomer
required
integer format: int64
byEmail
required
integer format: int64
count
required
integer format: int64
examples
required
Array<object>
object
amountCents
integer format: int64
currency
string
customer
string
email
required
string
endedAt
string format: date-time
name
string
paidThrough
string format: date-time
period
string
row
required
integer format: int64
tier
string
paidFirst
string format: date-time
paidLast
string format: date-time
platform
required
string
prices
required
Array<object>
object
amountCents
required
integer format: int64
currency
required
string
known
required
boolean
legacy
required
boolean
period
required
string
Allowed values: month year ""
priceId
required
string
subscriptions
required
integer format: int64
tierId
string
problem
string
Allowed values: no_email ""
rows
required
integer format: int64
source
required
string
Allowed values: substack ghost beehiiv kit csv
startedAt
string format: date-time
stats
object
compFirst
string format: date-time
compLast
string format: date-time
complimentary
required
integer format: int64
emailsSent
required
integer format: int64
free
required
integer format: int64
merged
required
integer format: int64
new
required
integer format: int64
paid
required
integer format: int64
pricesMapped
required
integer format: int64
skipped
required
integer format: int64
status
required
string
Allowed values: uploaded matched importing done failed canceled
tiers
required
Array<object>
object
id
required
string
name
required
string
withCustomer
required
integer format: int64

Example 

{
  "columns": [
    {
      "usedAs": "email"
    }
  ],
  "decisions": {
    "noSubscription": "complimentary"
  },
  "mode": "live",
  "prices": [
    {
      "period": "month"
    }
  ],
  "problem": "no_email",
  "source": "substack",
  "status": "uploaded"
}

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