Toast
API Reference

Settings

Site settings management. Authentication required.

Get all site settings

GET
/api/settings

Returns the full site settings including both public and private settings. Authentication required.

Response Body

Site settings

application/json
  1. response
public*
private*
Example Request
curl -X GET 'https://example.com/api/settings'
Example Response
{  "public": {    "name": "string",    "description": "string",    "logo": "http://example.com",    "icon": "http://example.com",    "coverImage": "http://example.com",    "accentColor": "string",    "timezone": "string",    "locale": "string",    "metaTitle": "string",    "metaDescription": "string",    "ogImage": "http://example.com"  },  "private": {}}

Update site settings

PATCH
/api/settings

Partially update site settings. Only provided fields are changed.

Request Body

application/json
  1. body
public?
private?

Response Body

Settings updated

application/json
  1. response
public*
private*
Example Request
curl -X PATCH 'https://example.com/api/settings' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "public": {    "name": "string",    "description": "string",    "logo": "http://example.com",    "icon": "http://example.com",    "coverImage": "http://example.com",    "accentColor": "string",    "timezone": "string",    "locale": "string",    "metaTitle": "string",    "metaDescription": "string",    "ogImage": "http://example.com"  },  "private": {}}