Website › Home & navigation

GET

/api/v1/workspaces/{workspace}/website/home-nav

package main

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

func main() {

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

  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/home-nav';
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/home-nav \
  --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

about

required

object

link

required

string

<= 500 characters

text

required

string

<= 1200 characters

title

required

string

<= 80 characters

featured

required

Array<object>

object

required

string

publishedAt

string format: date-time

status

required

string

tag

string

tiers

required

Array<string>

title

required

string

visibility

required

string

footer

required

object

archive

required

boolean

preferences

required

boolean

rss

required

boolean

header

required

Array<object>

object

kind

required

string

Allowed values: home tag page archive url

label

string

<= 40 characters

name

required

string

path

required

string

posts

required

integer format: int64

ref

string

<= 120 characters

url

string

<= 500 characters

identity

required

object

description

required

string

<= 300 characters

socialImage

required

string

<= 1000 characters

tagline

required

string

<= 160 characters

title

required

string

<= 80 characters

index

required

boolean

initial

required

string

layout

required

string

Allowed values: featured list grid

logo

required

string

pages

required

Array<object>

object

slug

required

string

title

required

string

poweredBy

required

boolean

privacyUrl

required

string

sections

required

Array<object>

object

count

integer format: int64

<= 24

kind

required

string

Allowed values: subscribe featured latest tag about tiers

note

string

<= 200 characters

required

boolean

tag

string

text

string

<= 300 characters

tags

required

Array<object>

object

description

required

string

feed

required

string

required

string

inNav

required

boolean

list

string

name

required

string

posts

required

integer format: int64

slug

required

string

unpublished

required

integer format: int64

url

required

string

updatedAt

required

string format: date-time

updatedBy

string

urls

required

object

archiveFeed

required

string

feed

required

string

sitemap

required

string

tagFeed

required

string

Example

{
  "header": [
    {
      "kind": "home"
    }
  ],
  "layout": "featured",
  "sections": [
    {
      "kind": "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"
}