Website › Access: members, sign-up, visibility defaults, the meter and the paywall

GET

/api/v1/workspaces/{workspace}/website/access

package main

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

func main() {

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

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

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

campaignVisibility

required

string

Allowed values: audience public members paid

defaultVisibility

required

string

Allowed values: public members paid

linkMinutes

required

integer format: int64

lists

required

Array<object>

object

checked

required

boolean

consent

required

string

required

string

name

required

string

offered

required

boolean

public

required

boolean

members

required

object

lastWeek

required

integer format: int64

linkMinutes

required

integer format: int64

paid

required

integer format: int64

sessionDays

required

integer format: int64

signedIn

required

integer format: int64

signinOn

required

boolean

signupLists

required

Array<object>

object

checked

required

boolean

consent

required

string

required

string

name

required

string

offered

required

boolean

public

required

boolean

signupOn

required

boolean

membersOnlyPosts

required

integer format: int64

meterMembers

required

integer format: int64

meterMembersOn

required

boolean

meterVisitors

required

integer format: int64

meterVisitorsOn

required

boolean

neverFree

required

Array<object>

object

required

string

publishAt

string format: date-time

publishedAt

string format: date-time

status

required

string

tiers

required

Array<string>

title

required

string

visibility

required

string

paidPosts

required

integer format: int64

payments

required

object

account

required

string

connected

required

boolean

mode

required

string

Allowed values: live test ""

paywall

required

object

free

required

string

<= 200 characters

heading

required

string

<= 120 characters

signup

required

string

<= 40 characters

text

required

string

<= 400 characters

tiers

required

Array<string>

<= 10 items

upgrade

required

string

<= 40 characters

senderEmail

required

string

senderName

required

string

sessionDays

required

integer format: int64

signinOn

required

boolean

signupOn

required

boolean

since

required

string format: date-time

systemProvider

required

string

tiers

required

Array<object>

object

currency

required

string

required

string

includes

string

label

required

string

monthly

required

integer format: int64

name

required

string

public

required

boolean

trialDays

required

integer format: int64

yearly

required

integer format: int64

updatedAt

required

string format: date-time

updatedBy

string

Example

{
  "campaignVisibility": "audience",
  "defaultVisibility": "public",
  "payments": {
    "mode": "live"
  }
}

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