Admin Preferences

Get Preferences

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses

200

Successful Response

application/json

company_namestringRequired

company_logoany ofOptional

stringOptional

or

nullOptional

user_session_timeoutany ofOptional

integerOptional

or

nullOptional

admin_session_timeoutany ofOptional

integerOptional

or

nullOptional

archive_after_daysany ofOptional

integerOptional

or

nullOptional

notification_includedany ofOptionalDefault: []

string[]Optional

or

nullOptional

idany ofOptional

integerOptional

or

nullOptional

get

/api/v1/admin_preferences

HTTPcURLJavaScriptPython

GET /api/v1/admin_preferences HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "company_name": "text",
  "company_logo": "text",
  "user_session_timeout": 1,
  "admin_session_timeout": 1,
  "archive_after_days": 1,
  "notification_included": [
    "text"
  ],
  "id": 1
}

Create Preferences

post

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Header parameters

authorizationstringRequired

Access token

Body

application/json

company_namestringRequired

company_logoany ofOptional

stringOptional

or

nullOptional

user_session_timeoutany ofOptional

integerOptional

or

nullOptional

admin_session_timeoutany ofOptional

integerOptional

or

nullOptional

archive_after_daysany ofOptional

integerOptional

or

nullOptional

notification_includedany ofOptionalDefault: []

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

company_namestringRequired

company_logoany ofOptional

stringOptional

or

nullOptional

user_session_timeoutany ofOptional

integerOptional

or

nullOptional

admin_session_timeoutany ofOptional

integerOptional

or

nullOptional

archive_after_daysany ofOptional

integerOptional

or

nullOptional

notification_includedany ofOptionalDefault: []

string[]Optional

or

nullOptional

422

Validation Error

application/json

post

/api/v1/admin_preferences

HTTPcURLJavaScriptPython

POST /api/v1/admin_preferences HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "company_name": "text",
  "company_logo": "text",
  "user_session_timeout": 1,
  "admin_session_timeout": 1,
  "archive_after_days": 1,
  "notification_included": [
    "text"
  ]
}

{
  "company_name": "text",
  "company_logo": "text",
  "user_session_timeout": 1,
  "admin_session_timeout": 1,
  "archive_after_days": 1,
  "notification_included": [
    "text"
  ]
}

Update Preferences

put

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

idintegerRequired

Header parameters

authorizationstringRequired

Access token

Body

application/json

company_nameany ofOptional

stringOptional

or

nullOptional

company_logoany ofOptional

stringOptional

or

nullOptional

user_session_timeoutany ofOptional

integerOptional

or

nullOptional

admin_session_timeoutany ofOptional

integerOptional

or

nullOptional

archive_after_daysany ofOptional

integerOptional

or

nullOptional

notification_includedany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

company_namestringRequired

company_logoany ofOptional

stringOptional

or

nullOptional

user_session_timeoutany ofOptional

integerOptional

or

nullOptional

admin_session_timeoutany ofOptional

integerOptional

or

nullOptional

archive_after_daysany ofOptional

integerOptional

or

nullOptional

notification_includedany ofOptionalDefault: []

string[]Optional

or

nullOptional

422

Validation Error

application/json

put

/api/v1/admin_preferences/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/admin_preferences/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "company_name": "text",
  "company_logo": "text",
  "user_session_timeout": 1,
  "admin_session_timeout": 1,
  "archive_after_days": 1,
  "notification_included": [
    "text"
  ]
}

{
  "company_name": "text",
  "company_logo": "text",
  "user_session_timeout": 1,
  "admin_session_timeout": 1,
  "archive_after_days": 1,
  "notification_included": [
    "text"
  ]
}

Get Dashboard Info

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters

start_datestringOptional

end_datestringOptional

Header parameters

authorizationstringRequired

Access token

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/admin_preferences/dashboard_info

HTTPcURLJavaScriptPython

GET /api/v1/admin_preferences/dashboard_info HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Accept: */*

No content

Patch Setting

patch

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

namestringRequired

Body

application/json

Other propertiesanyOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

patch

/api/v1/admin_preferences/settings/{name}

HTTPcURLJavaScriptPython

PATCH /api/v1/admin_preferences/settings/{name} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

Get Users With No Password

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses

200

Successful Response

application/json

anyOptional

get

/api/v1/admin_preferences/users_no_password

HTTPcURLJavaScriptPython

GET /api/v1/admin_preferences/users_no_password HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

No content