Cirqll Core
HomeCirqll
HomeCirqll
  1. Setting
  • Query Parameters
    • Eager Loading
    • Partial Data
    • Count Relations
    • Pagination
      • Filter
      • Order By
  • Authentication
    • OAuth2
      • Authorize
        • Authorize
      • User
        • Me
      • Client
        • Index
        • Create
        • Update
        • Delete
      • Token
        • Create
        • Refresh
        • Index
      • Scopes
  • User
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Role
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Customer
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Contact
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Appointment
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Task
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Financial
    • Chance
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Assignment
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Contract
      • Index
      • Show
      • Create
      • Update
      • Delete
  • Email
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Field
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Note
    • Index
    • Show
    • Create
    • Update
    • Delete
  • To-do
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Template
    • Index
    • Show
    • Update
    • Create
    • Delete
  • Setting
    • Index
      GET
    • Update
      PATCH
  • Webhook
    • Index
    • Show
    • Create
    • Update
    • Delete
  1. Setting

Index

GET
/setting
Get the settings of the logged-in user

Request

Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Header Params
Accept
string 
optional
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.cirqll.nl/api/setting' \
--header 'Accept: application/json'

Responses

🟢200Success
application/json
Body
startup
enum<string> 
required
Allowed values:
mapdashboardoverview/chances
Default:
map
chance_1
string 
required
chance_2
string 
required
chance_3
string 
required
chance_4
string 
required
chance_5
string 
required
email_interval
enum<string> 
required
Get a status update in your inbox every morning or monday at 7 AM
Allowed values:
dailyweeklynever
Default:
daily
dashboard_todo
boolean 
required
Toggle the todos card on or off on your dashboard
Default:
true
dashboard_chance
boolean 
required
Toggle the chances card on or off on your dashboard
Default:
true
dashboard_contract
boolean 
required
Toggle the contracts card on or off on your dashboard
Default:
true
color_mode
enum<string> 
required
Allowed values:
lightdark
Default:
light
language
enum<string> 
required
Allowed values:
nlende
Default:
nl
show_information
boolean 
required
Show the little information icon on certain functions in Cirqll
Default:
true
show_on_map_default
boolean 
required
Sets the default for the "Show on map" toggle when you create a new customer (Frontend only!)
Default:
true
chance_layout_is_grid
boolean 
required
Default:
false
financial_goal
integer <uint32>
required
Show a progress bar on your financial dashboard to check up on your progress every year
>= 0
Default:
0
two_factor_mode
enum<string> 
required
Allowed values:
nonemailqr
Default:
none
Example
{
  "startup": "map",
  "chance_1": "string",
  "chance_2": "string",
  "chance_3": "string",
  "chance_4": "string",
  "chance_5": "string",
  "email_interval": "daily",
  "dashboard_todo": true,
  "dashboard_chance": true,
  "dashboard_contract": true,
  "color_mode": "light",
  "language": "nl",
  "show_information": true,
  "show_on_map_default": true,
  "chance_layout_is_grid": false,
  "financial_goal": 0,
  "two_factor_mode": "none"
}
🟠401Not Logged In
🔴500Server Error
Modified at 2025-05-06 02:34:28
Previous
Setting
Next
Update
Built with