Skip to main content

Retrieve General Settings

Retrieves the current general settings of the project.

HTTP Request

GET/api/settings/general

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with GeneralSettingsPermission or Admin
  • Permission Code: 1001
  • 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())

Response Fields

FieldTypeDescription
astringDescription for setting a
bstringDescription for setting b
cstringDescription for setting c

Example Response

{
"a": "x",
"b": "y",
"c": "z"
}

Notes

  • This endpoint currently has no practical usage