Skip to main content

Retrieve Contact Settings

Retrieves the current contact settings of the platform.

HTTP Request

GET/api/settings/contacts

Authorization

Authorization

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

Example Requests

1import requests
2
3# Retrieve contact settings
4response = requests.get('http://www.example.com/api/settings/contacts', 
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(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
ContactObjectDefault consultation support configuration (JSON, default: {})
QuestionObjectDefault question support configuration (JSON, default: {})

ContactObject Structure

FieldTypeDescription
emailStringConsultation support email address
messageStringConsultation support message template
subjectStringConsultation support subject line
mobile_numberStringConsultation support phone number
first_nameStringConsultation support first name
last_nameStringConsultation support last name

QuestionObject Structure

FieldTypeDescription
emailStringQuestion support email address
messageStringQuestion support message template
subjectStringQuestion support subject line
mobile_numberStringQuestion support phone number
first_nameStringQuestion support first name
last_nameStringQuestion support last name