Get a signup form's copy in every language

GET

/api/v1/workspaces/{workspace}/forms/{form}/copy

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/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/forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/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/forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/copy \
  --header 'Authorization: Bearer <token>'

Permission: subscribers:view

The form’s language mode, each language’s status and text, its consent text’s version and the latest consent given in it.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

form

required

Form id

string format: uuid

Form id

Responses

200

application/json

object

consentChangedAt

string format: date-time

consentChangedBy

required

string

consentVersion

required

integer format: int64

copyLanguage

required

The language the form is written in

string

fallback

required

The language the form shows where one isn’t Live

string

fields

required

Array<object>

object

key

required

string

source

required

Its label in the form’s own language

string

fixedLanguage

required

string

formId

required

string

languageMode

required

string

Allowed values: page browser fixed

languages

required

Array<object>

object

string format: date-time

required

string

code

required

string

consentFor

required

integer format: int64

consentReview

required

The form’s own consent text changed since: Review the translation

boolean

consentVersion

required

integer format: int64

copy

required

object

afterSubmit

required

What the form says after a signup

string

<= 300 characters

button

required

string

<= 40 characters

consentText

required

string

<= 600 characters

description

required

string

<= 500 characters

fields

required

object

<= 20 properties

key

additional properties

string

heading

required

string

<= 120 characters

defaultAfterSubmit

required

string

evidence

object

required

string format: date-time

contactId

required

string

name

required

string

version

required

string

isDefault

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

status

required

string

Allowed values: live incomplete not_set_up

total

required

integer format: int64

written

required

integer format: int64

Example

{
  "languageMode": "page",
  "languages": [
    {
      "code": "es",
      "evidence": {
        "version": "v1"
      },
      "name": "Spanish",
      "native": "Español",
      "status": "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"
}