{% extends "docs/base.html" %} {% block docs_content %}

Get site settings

Get current site-wide settings. Requires staff access.

Endpoint

GET /api/v1/site-settings
Authenticated Staff only

Usage

curl \
  --header "Authorization: Bearer $PEARING_API_TOKEN" \
  "$PEARING_API_URL/v1/site-settings"

Success

200 OK with current settings.

{ "signups_enabled": true, "signups_require_invite": false, "signup_invite_min_account_age": "1w", "signup_invite_max_per_24h": 3, "signup_invite_creators": "staff" }

Errors

403 Forbidden if the authenticated user is not staff.

{% endblock %}