Skip to main content

Retrieve General Settings

Retrieves the current general settings of the platform.

HTTP Request

GET/api/settings/general

Authorization

Authorization

  • Required: Yes
  • Permission: Staff or Admin
  • Authentication: Token authentication

Example Requests

1# Retrieve general settings
2response = requests.get('http://www.example.com/api/settings/general', 
3  headers={'Authorization': 'Token <your_api_key>'}
4)
5print(response.json())

Status Codes

CodeDescription
200Request logs retrieved successfully
400Bad request — invalid query parameters
401Unauthorized — authentication required
403Forbidden — insufficient permissions
500Internal server error

Response Fields

FieldTypeDescription
astringDescription for setting a
bstringDescription for setting b
cintegerDescription for setting c
dbooleanDescription for setting d
estringDescription for setting e