Settings

Manage all system settings including general, email, modules, integrations, tickets, tasks, IMAP, notifications, and more.

Available Endpoints

Method Path Description
GET /api/settings Get all settings
GET /api/settings/client-permissions Get client permission settings
PUT /api/settings/general Update general settings
PATCH /api/settings/general Partial update of general settings
PUT /api/settings/email Update email settings
PATCH /api/settings/email Partial update of email settings
PUT /api/settings/ip-restriction Update IP restriction
PATCH /api/settings/ip-restriction Partial update of IP restriction
PUT /api/settings/client-permissions Update client permissions
PATCH /api/settings/client-permissions Partial update of client permissions
GET /api/settings/invoices Get invoice settings
PUT /api/settings/invoices/style Update invoice style
PATCH /api/settings/invoices/style Partial update of invoice style
PUT /api/settings/invoices/general Update general invoice settings
PATCH /api/settings/invoices/general Partial update of general invoice settings
PUT /api/settings/invoices/reminders Update invoice reminders
PATCH /api/settings/invoices/reminders Partial update of invoice reminders
PUT /api/settings/events Update event settings
PATCH /api/settings/events Partial update of event settings
GET /api/settings/notifications/categories Get notification categories
GET /api/settings/notifications List notifications
GET /api/settings/notifications/{id} View a notification
PUT /api/settings/notifications/{id} Update a notification
PATCH /api/settings/notifications/{id} Partial update of a notification
PUT /api/settings/modules Update modules
PATCH /api/settings/modules Partial update of modules
PUT /api/settings/integrations/recaptcha Update reCAPTCHA settings
PATCH /api/settings/integrations/recaptcha Partial update of reCAPTCHA
PUT /api/settings/integrations/bitbucket Update Bitbucket settings
PATCH /api/settings/integrations/bitbucket Partial update of Bitbucket
PUT /api/settings/tickets Update ticket settings
PATCH /api/settings/tickets Partial update of ticket settings
GET /api/settings/tasks Get task settings
PUT /api/settings/tasks Update task settings
PATCH /api/settings/tasks Partial update of task settings
PUT /api/settings/imap Update IMAP settings
PATCH /api/settings/imap Partial update of IMAP
POST /api/settings/imap/authorize IMAP authentication
PUT /api/settings/integrations/push-notification Update push notification settings
PATCH /api/settings/integrations/push-notification Partial update of push notification settings
POST /api/settings/integrations/push-notification/test Test push notification
PUT /api/settings/integrations/google-drive Update Google Drive settings
PATCH /api/settings/integrations/google-drive Partial update of Google Drive
GET /api/settings/estimates Get estimate settings
PUT /api/settings/estimates Update estimate settings
PATCH /api/settings/estimates Partial update of estimate settings
PUT /api/settings/timesheets Update timesheet settings
PATCH /api/settings/timesheets Partial update of timesheet settings
PUT /api/settings/gdpr Update GDPR settings
PATCH /api/settings/gdpr Partial update of GDPR
GET /api/settings/footer Get footer settings
PUT /api/settings/footer Update footer settings
PATCH /api/settings/footer Partial update of footer
PUT /api/settings/top-menu Update top menu settings
PATCH /api/settings/top-menu Partial update of top menu
GET /api/settings/estimate-requests Get estimate request settings
PUT /api/settings/estimate-requests Update estimate request settings
PATCH /api/settings/estimate-requests Partial update of estimate request settings
GET /api/settings/orders Get order settings
PUT /api/settings/orders Update order settings
PATCH /api/settings/orders Partial update of order settings
GET /api/settings/projects Get project settings
PUT /api/settings/projects Update project settings
PATCH /api/settings/projects Partial update of project settings
PUT /api/settings/integrations/slack Update Slack settings
PATCH /api/settings/integrations/slack Partial update of Slack
POST /api/settings/integrations/slack/test Test Slack notification
GET /api/settings/client-projects Get client project settings
PUT /api/settings/client-projects Update client projects
PATCH /api/settings/client-projects Partial update of client projects
PUT /api/settings/integrations/github Update GitHub settings
PATCH /api/settings/integrations/github Partial update of GitHub
GET /api/settings/contracts Get contract settings
PUT /api/settings/contracts Update contract settings
PATCH /api/settings/contracts Partial update of contract settings
GET /api/settings/leads Get lead settings
PUT /api/settings/leads Update lead settings
PATCH /api/settings/leads Partial update of lead settings
GET /api/settings/proposals Get proposal settings
PUT /api/settings/proposals Update proposal settings
PATCH /api/settings/proposals Partial update of proposal settings
GET /api/settings/localization Get localization settings
PUT /api/settings/localization Update localization settings
PATCH /api/settings/localization Partial update of localization
GET /api/settings/store Get store settings
PUT /api/settings/store Update store settings
PATCH /api/settings/store Partial update of store
PUT /api/settings/pwa Update PWA settings
PATCH /api/settings/pwa Partial update of PWA

Example Request

curl -X GET "https://example.com/api/settings" \
  -H "Authorization: Bearer {token}"

Success Response (200)

{
  "records": {}
}

Errors

Code Description
401 Invalid token
403 Access denied
422 Validation error
Type to search...