Get the public pages' copy in every language

GET

/api/v1/workspaces/{workspace}/public-pages/copy

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/public-pages/copy"

  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/public-pages/copy';
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/public-pages/copy \
  --header 'Authorization: Bearer <token>'

Permission: subscribers:view

Each workspace language’s status (Live, Incomplete with the strings still to write, or Not set up) and, with ?language=, that language’s strings next to the pages’ own.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Query Parameters

language

Also return this language’s strings

string

<= 35 characters

Also return this language’s strings

Responses

200

application/json

object

copyLanguage

required

The language the pages are written in

string

default

required

string

fallback

required

string

language

required

The language of strings (?language=)

string

languages

required

Array<object>

object

string format: date-time

required

string

code

required

string

isDefault

required

boolean

isFallback

required

boolean

isSource

required

boolean

labels

required

object

string format: date-time

required

Who wrote them last

string

shipped

required

boolean

total

required

integer format: int64

written

required

Labels with text in the language (all of them when they ship)

integer format: int64

missing

required

integer format: int64

name

required

string

native

required

string

own

required

integer format: int64

status

required

string

Allowed values: live incomplete not_set_up

written

required

integer format: int64

strings

required

Array<object>

object

key

required

string

listId

string

optional

required

boolean

page

required

string

Allowed values: subscribe confirm preferences unsubscribe lists privacy

source

required

string

text

required

string

Example

{
  "languages": [
    {
      "code": "es",
      "name": "Spanish",
      "native": "Español",
      "status": "live"
    }
  ],
  "strings": [
    {
      "key": "subscribe.heading",
      "page": "subscribe"
    }
  ]
}

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