The website: its address, state, numbers and what turning it on or off does
GET
/api/v1/workspaces/{workspace}/website
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/website"
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';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 \ --header 'Authorization: Bearer <token>'Permission: website:view
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspace
required
Workspace slug
string
Workspace slug
Responses
Section titled “Responses”OK
Media typeapplication/json
object
address
required
object
certificate
required
object
detail
string
issuer
string
renewsAt
string format: date-time
status
required
string
checkedAt
string format: date-time
domain
required
string
domainDetail
required
string
domainStatus
required
string
fallback
required
string
host
required
string
target
required
string
url
required
string
verifiedAt
string format: date-time
archive
required
object
enabled
required
boolean
feed
required
string
index
required
boolean
issues
required
integer format: int64
lists
required
Array<object>
object
archived
required
boolean
id
required
string
issues
required
integer format: int64
name
required
string
public
required
boolean
since
required
integer format: int64
tags
required
Array<string>
url
required
string
helpers
required
object
manage
required
Array<string>
publish
required
Array<string>
homeLayout
required
string
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
id
required
string
name
required
string
offered
required
boolean
public
required
boolean
signupOn
required
boolean
numbers
required
object
from
required
string format: date-time
signups
required
integer format: int64
until
required
string format: date-time
upgrades
required
integer format: int64
views
required
integer format: int64
visitors
required
integer format: int64
off
required
object
paidMembers
required
integer format: int64
publicPages
required
integer format: int64
shop
required
boolean
webOnly
required
integer format: int64
posts
required
object
all
required
integer format: int64
draft
required
integer format: int64
fromCampaigns
required
integer format: int64
membersOnly
required
integer format: int64
paid
required
integer format: int64
published
required
integer format: int64
scheduled
required
integer format: int64
unpublished
required
integer format: int64
webOnly
required
integer format: int64
progress
object
finishedAt
string format: date-time
pages
required
string
posts
required
object
done
required
integer format: int64
names
Array<string>
total
required
integer format: int64
redirects
required
object
done
required
integer format: int64
names
Array<string>
total
required
integer format: int64
startedAt
string format: date-time
tags
required
object
done
required
integer format: int64
names
Array<string>
total
required
integer format: int64
status
required
string
title
required
string
turnedOnAt
string format: date-time
turnedOnBy
string
updatedAt
required
string format: date-time
updatedBy
string
Example
{ "address": { "certificate": { "status": "valid" }, "domainStatus": "none" }, "homeLayout": "featured", "progress": { "pages": "waiting" }, "status": "off"}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
Example
{ "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}