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

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/settings"
{
  "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": {}
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Update site settings

PATCH
/api/settings

Partially update site settings. Only provided fields are changed.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://loading/api/settings" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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": {}
}
{
  "error": "string",
  "details": [
    {
      "code": "string",
      "message": "string",
      "path": [
        "string"
      ]
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}