GET
/api/admin/settingsAdminRead the deployment settings
operationId
getDeploymentSettingsAdmin: SettingsAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Access token (Bearer)
Authorization: Bearer <JWT> - Access token (cookie)
cookie "access_token_schemavaults-mail"
- Access token (Bearer)
- Who may call
- Platform administrators only
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| data* | DeploymentSettings | Deployment-wide settings managed at /admin/settings. |
| default_time_zone* | string | null | null | IANA time zone the admin pages show times in and group email traffic by (e.g. maxLength: 64 |
| updated_at* | number | null | null | Unix epoch milliseconds when an admin last changed the settings, or null if they never have. minimum: 0 |
JSONExample
"success"true
"data"
"default_time_zone""America/New_York"
"updated_at"1.5
Example request
bashcurl
curl -X GET 'https://mail.schemavaults.com/api/admin/settings' \
-H 'Authorization: Bearer <access_token>'