Skip to main content

Retrieve Customer Settings

Retrieves the current customer settings of the project.

HTTP Request

GET/api/settings/customers

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with CustomersSettingsPermission or Admin
  • Permission Code: 1016
  • Authentication: Token authentication

Example Requests

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

Response Fields

FieldTypeDescription
customers_default_customer_statusBooleanDefault status of a customer (active or not, default: false)

Example Response

{
"customers_default_customer_status": false
}