Skip to main content

Retrieve Web Client Settings

Retrieves the web client settings of the project

HTTP Request

GET/api/settings/web_client

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with WebClientSettingsPermission or Admin
  • Permission Code: 1031
  • Authentication: Token authentication

Example Requests

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

Response Fields

FieldTypeDescription
web_client_failed_payment_urlURLURL for failed payment redirects (default: "http://localhost:8000/failed_payment")
web_client_successful_payment_urlURLURL for successful payment redirects (default: "http://localhost:8000/successful_payment")

Example Response

{
"web_client_failed_payment_url": "http://localhost:8000/failed_payment",
"web_client_successful_payment_url": "http://localhost:8000/successful_payment"
}