Read blog-wide settings (whether the subscribe box and comments are enabled).

GEThttps://app.softsolz.uk/api/v1/services/blogs/settings

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

comments_enabledbooleanDefault for "Allow comments" on newly created posts.

comments_require_approvalbooleanWhen true, reader comments are held as pending and only appear after a moderator approves them.

subscribe_enabledbooleanWhether the newsletter subscribe box is shown on the blog.

author_namestringBlog-wide default byline name.

author_image_urlstringBlog-wide default byline avatar image URL.

show_toc_defaultbooleanDefault for "Show table of contents" on newly created posts.

show_share_defaultbooleanDefault for "Show reader share buttons" on newly created posts.

show_date_defaultbooleanDefault for "Show publish date" on newly created posts.

show_reading_time_defaultbooleanDefault for "Show reading time" on newly created posts.

share_channelsarray of stringsNetworks offered in the reader share bar.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.blogs.getSettings();
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "comments_enabled": true,
    "comments_require_approval": true,
    "subscribe_enabled": true,
    "author_name": "string",
    "author_image_url": "string",
    "show_toc_default": true,
    "show_share_default": true,
    "show_date_default": true,
    "show_reading_time_default": true,
    "share_channels": []
  }
}