S-Launch

Appearance

Interactive Reference ​

The full S-Launch OpenAPI specification, rendered as an interactive reference. Every endpoint, every request and response schema, and every model is available here for inspection.

Use this page when you want to:

  • Inspect the full schema of a request or response body.
  • Copy an endpoint signature for a client SDK.
  • Drill into nested model references that the hand-written endpoint pages only mention by name.

The same data is also available as raw openapi.json for import into Postman, Insomnia, Stoplight, and other OpenAPI 3.x tools.

Upload avatar for self​

POST
/api/self/avatar

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Request Body​

multipart/form-data
object
Format"binary"

Responses​

Upload avatar for self

application/json
JSON
[
]

Playground​

Server
Authorization
Body

Samples​

Get user avatar​

GET
/api/users/{id}/avatar

Get the avatar for the user by ID (active only in dev or debug modes)

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Successful Response

application/json
JSON
[
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Get menu config​

GET
/api/ui/menu

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
[
  
{
  
  
"title": "string",
  
  
"icon": "string",
  
  
"link": "string",
  
  
"subItems": [
  
  
  
{
  
  
  
}
  
  
],
  
  
"scopes": [
  
  
  
"string"
  
  
]
  
}
]

Playground​

Server
Authorization

Samples​

Server Heartbeat​

Operations​

GET/api/heartbeat/

Heartbeat​

GET
/api/heartbeat/

Responses​

Successful Response

application/json
JSON
{
  
"status": "string",
  
"debug_mode": true,
  
"activated": true,
  
"demo": true,
  
"startup_time": 0,
  
"next_purge": 0,
  
"version": "string",
  
"build_number": 0
}

Playground​

Samples​

Login​

POST
/api/login/access-token

OAuth2 compatible token login, get an access token for future requests

Request Body​

application/x-www-form-urlencoded
object
string |null
Default""
string |null
string |null

Responses​

Successful Response

application/json
JSON
{
  
"access_token": "string",
  
"token_type": "string"
}

Playground​

Server
Body

Samples​

Form Submissions​

Operations​

GET/api/form/history/filtersGET/api/form/history/GET/api/form/history/{id}DELETE/api/form/history/{id}

Get Form Submission filter metadata​

GET
/api/form/history/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Form Viewer​

Operations​

GET/api/form/filtersGET/api/form/GET/api/form/{url_or_id}POST/api/form/{id}/uploadPOST/api/form/{id}

Get Form filter metadata​

GET
/api/form/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Form Builder​

Operations​

GET/api/formbuilder/{id}/thumbnailPOST/api/formbuilder/{id}/thumbnailGET/api/formbuilder/filtersGET/api/formbuilder/POST/api/formbuilder/GET/api/formbuilder/{id}PUT/api/formbuilder/{id}DELETE/api/formbuilder/{id}PATCH/api/formbuilder/{id}

Get thumbnail for Dynamic Form by ID​

GET
/api/formbuilder/{id}/thumbnail

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Get thumbnail for form by id

application/json
JSON
[
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Blueprints​

Operations​

GET/api/factory/workflows/{id}/thumbnailPOST/api/factory/workflows/{id}/thumbnailGET/api/factory/workflows/filtersGET/api/factory/workflows/POST/api/factory/workflows/GET/api/factory/workflows/{id}PUT/api/factory/workflows/{id}DELETE/api/factory/workflows/{id}PATCH/api/factory/workflows/{id}

Get thumbnail for workflow template by ID​

GET
/api/factory/workflows/{id}/thumbnail

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Get thumbnail for workflow template by id

application/json
JSON
[
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Tickets​

Operations​

GET/api/factory/tickets/filtersGET/api/factory/tickets/GET/api/factory/tickets/{id}

Get Ticket filter metadata​

GET
/api/factory/tickets/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Assemblies​

Operations​

GET/api/factory/history/filtersGET/api/factory/history/GET/api/factory/history/{id}DELETE/api/factory/history/{id}

Get Assembly filter metadata​

GET
/api/factory/history/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Tasks​

Operations​

GET/api/factory/tasks/filtersGET/api/factory/tasks/GET/api/factory/tasks/{id}DELETE/api/factory/tasks/{id}

Get Task filter metadata​

GET
/api/factory/tasks/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Blueprint Builder Helpers​

Operations​

GET/api/factory/ucs-allowed-scopesGET/api/factory/smartnamesGET/api/factory/storeGET/api/factory/mailtemplates/filtersGET/api/factory/mailtemplates/

Get factory UCS allowed scopes​

GET
/api/factory/ucs-allowed-scopes

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
[
  
"string"
]

Playground​

Server
Authorization

Samples​

Asset Store​

Operations​

GET/api/store/

Get Store Object By Url​

GET
/api/store/

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Query Parameters

url
Type
string
Default
""
as_json

Return JSON response

Type
boolean
Default
false
hydrate

Whether to expand referenced objects (default: True). Set to False to return referenced objects as simple IDs/URLs for better performance.

Type
boolean
Default
true

Responses​

Get Asset Store object by url

application/json
JSON
{
  
"created": 0,
  
"created_by": {
  
  
"id": "string",
  
  
"login": "Unavailable",
  
  
"name": "Unavailable",
  
  
"surname": "Unavailable"
  
},
  
"modified": 0,
  
"modified_by": {
  
  
"id": "string",
  
  
"login": "Unavailable",
  
  
"name": "Unavailable",
  
  
"surname": "Unavailable"
  
},
  
"name": "string",
  
"control": {
  
  
"system": false,
  
  
"readonly": false,
  
  
"protected": false,
  
  
"hidden": false
  
},
  
"id": "string",
  
"depth": 0,
  
"url": "string",
  
"description": "string",
  
"public": true,
  
"parent": {
  
  
"id": "string",
  
  
"name": "Unavailable",
  
  
"url": "string"
  
},
  
"assets": [
  
  
{
  
  
  
"created": 0,
  
  
  
"modified": 0,
  
  
  
"name": "string",
  
  
  
"control": {
  
  
  
  
"system": false,
  
  
  
  
"readonly": false,
  
  
  
  
"protected": false,
  
  
  
  
"hidden": false
  
  
  
},
  
  
  
"id": "string",
  
  
  
"mime_type": "string",
  
  
  
"type": "string",
  
  
  
"size": 0,
  
  
  
"url": "string"
  
  
}
  
],
  
"folders": [
  
  
{
  
  
  
"created": 0,
  
  
  
"modified": 0,
  
  
  
"name": "string",
  
  
  
"control": {
  
  
  
  
"system": false,
  
  
  
  
"readonly": false,
  
  
  
  
"protected": false,
  
  
  
  
"hidden": false
  
  
  
},
  
  
  
"id": "string",
  
  
  
"url": "string",
  
  
  
"public": true
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Folders​

Operations​

GET/api/store/folder/{id}/downloadGET/api/store/folder/{id}/sharesGET/api/store/folder/filtersGET/api/store/folder/POST/api/store/folder/GET/api/store/folder/{id}PUT/api/store/folder/{id}DELETE/api/store/folder/{id}PATCH/api/store/folder/{id}

Download Folder​

GET
/api/store/folder/{id}/download

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Successful Response

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Assets​

Operations​

POST/api/store/asset/uploadGET/api/store/asset/downloadGET/api/store/asset/{id}/sharesGET/api/store/asset/filtersGET/api/store/asset/GET/api/store/asset/{id}PUT/api/store/asset/{id}DELETE/api/store/asset/{id}PATCH/api/store/asset/{id}

Upload Asset​

POST
/api/store/asset/upload

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Query Parameters

folder

Request Body​

multipart/form-data
object
Format"binary"

Responses​

Successful Response

application/json
JSON
{
  
"created": 0,
  
"created_by": {
  
  
"id": "string",
  
  
"login": "Unavailable",
  
  
"name": "Unavailable",
  
  
"surname": "Unavailable"
  
},
  
"modified": 0,
  
"modified_by": {
  
  
"id": "string",
  
  
"login": "Unavailable",
  
  
"name": "Unavailable",
  
  
"surname": "Unavailable"
  
},
  
"name": "string",
  
"control": {
  
  
"system": false,
  
  
"readonly": false,
  
  
"protected": false,
  
  
"hidden": false
  
},
  
"id": "string",
  
"mime_type": "string",
  
"type": "string",
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"size": 0,
  
"url": "string",
  
"folder": {
  
  
"id": "string",
  
  
"name": "Unavailable",
  
  
"url": "string"
  
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Shares​

Operations​

POST/api/share/get_accessGET/api/share/POST/api/share/GET/api/share/download/{token}POST/api/share/send_emailGET/api/share/filtersGET/api/share/{id}PUT/api/share/{id}DELETE/api/share/{id}PATCH/api/share/{id}

Get Access To Share​

POST
/api/share/get_access

Request Body​

application/json
JSON
{
  
"id": "string",
  
"password": "string"
}

Responses​

Get access to share

application/json
JSON
{
  
"id": "string",
  
"expires_at": "string",
  
"downloads": 0,
  
"downloads_limit": 0,
  
"description": "string",
  
"created_by": {
  
  
"id": "string",
  
  
"login": "Unavailable",
  
  
"name": "Unavailable",
  
  
"surname": "Unavailable"
  
},
  
"created": "string",
  
"asset": {
  
  
"id": "string",
  
  
"name": "Unavailable",
  
  
"url": "string",
  
  
"mime_type": "string"
  
},
  
"folder": {
  
  
"id": "string",
  
  
"name": "Unavailable",
  
  
"url": "string"
  
},
  
"token": "string"
}

Playground​

Server
Body

Samples​

Groups​

Operations​

GET/api/admin/groups/{id}/usersPOST/api/admin/groups/{id}/users/{user_id}DELETE/api/admin/groups/{id}/users/{user_id}GET/api/admin/groups/filtersGET/api/admin/groups/POST/api/admin/groups/GET/api/admin/groups/{id}PUT/api/admin/groups/{id}DELETE/api/admin/groups/{id}PATCH/api/admin/groups/{id}

Get Group Users​

GET
/api/admin/groups/{id}/users

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Path Parameters

id*
Type
string
Required

Responses​

Successful Response

application/json
JSON
[
  
{
  
  
"created": 0,
  
  
"modified": 0,
  
  
"name": "string",
  
  
"control": {
  
  
  
"system": false,
  
  
  
"readonly": false,
  
  
  
"protected": false,
  
  
  
"hidden": false
  
  
},
  
  
"id": "string",
  
  
"surname": "",
  
  
"login": "",
  
  
"email": "noreply@s-launch.com",
  
  
"is_active": false,
  
  
"external": false,
  
  
"is_locked": false,
  
  
"invitation_pending": false
  
}
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Configuration​

Operations​

GET/api/admin/config/GET/api/admin/config/mail/verifyGET/api/admin/config/{key}PUT/api/admin/config/{key}PATCH/api/admin/config/{key}

Get all config keys​

GET
/api/admin/config/

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
"string"

Playground​

Server
Authorization

Samples​

Security Scope Sets​

Operations​

GET/api/admin/scope-sets/filtersGET/api/admin/scope-sets/POST/api/admin/scope-sets/GET/api/admin/scope-sets/{id}PUT/api/admin/scope-sets/{id}DELETE/api/admin/scope-sets/{id}PATCH/api/admin/scope-sets/{id}

Get Scope Set filter metadata​

GET
/api/admin/scope-sets/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Users​

Operations​

GET/api/admin/users/check-email-uniqueGET/api/admin/users/check-login-uniquePOST/api/admin/users/{id}/avatarDELETE/api/admin/users/{id}/avatarPOST/api/admin/users/{id}/unlockGET/api/admin/users/POST/api/admin/users/GET/api/admin/users/filtersGET/api/admin/users/{id}PUT/api/admin/users/{id}DELETE/api/admin/users/{id}PATCH/api/admin/users/{id}

Check if email is unique​

GET
/api/admin/users/check-email-unique

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Query Parameters

email*
Type
string
Required

Responses​

Successful Response

application/json
JSON
[
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

System Health​

Operations​

GET/api/admin/health/{full_service_name}GET/api/admin/health/

Return detailed service health snapshot​

GET
/api/admin/health/{full_service_name}

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Parameters​

Path Parameters

full_service_name*
Type
string
Required

Responses​

Successful Response

application/json
JSON
{
  
"startup_time": 0,
  
"timestamp": 0,
  
"id": "string",
  
"service": "string",
  
"instance_id": "string",
  
"fullname": "string",
  
"status": "string",
  
"hostname": "string",
  
"version": "string",
  
"pid": 0,
  
"python": "string",
  
"cmd_args": [
  
  
"string"
  
],
  
"uptime": "string",
  
"stale": true
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Api Keys​

Operations​

GET/api/admin/api-keys/scopesGET/api/admin/api-keys/POST/api/admin/api-keys/GET/api/admin/api-keys/filtersGET/api/admin/api-keys/{id}DELETE/api/admin/api-keys/{id}

Get all available API key scopes​

GET
/api/admin/api-keys/scopes

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
[
  
"string"
]

Playground​

Server
Authorization

Samples​

admin, activate​

Operations​

POST/api/activate/

Prepare bootstrap admin​

POST
/api/activate/

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Request Body​

application/json
JSON
{
  
"general": {
  
  
"project_name": "S-Launch",
  
  
"company_name": "Significans Inc.",
  
  
"default_language": "en",
  
  
"default_timezone": "UTC"
  
},
  
"mail": {
  
  
"sender_addr": "string",
  
  
"sender_name": "string",
  
  
"smtp_options": {
  
  
  
"host": "string",
  
  
  
"port": 0,
  
  
  
"ssl": false,
  
  
  
"user": "string",
  
  
  
"password": "string"
  
  
}
  
},
  
"admin_user": {
  
  
"name": "string",
  
  
"surname": "string",
  
  
"mail": "string"
  
}
}

Responses​

Successful Response

application/json
JSON
"string"

Playground​

Server
Authorization
Body

Samples​

Sessions​

Operations​

GET/api/admin/sessions/filtersGET/api/admin/sessions/GET/api/admin/sessions/{id}DELETE/api/admin/sessions/{id}

Get Session filter metadata​

GET
/api/admin/sessions/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Index Management​

Operations​

GET/api/admin/indexes/modelsGET/api/admin/indexes/{model_name}/statusPOST/api/admin/indexes/{model_name}/cleanupPOST/api/admin/indexes/{model_name}/recreatePOST/api/admin/indexes/{model_name}/recreate-all

Get list of available models for index management​

GET
/api/admin/indexes/models

Get list of all available models for index management.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
[
  
"string"
]

Playground​

Server
Authorization

Samples​

Defaults​

Operations​

GET/api/admin/defaults/POST/api/admin/defaults/menu/recreatePOST/api/admin/defaults/templates/recreatePOST/api/admin/defaults/blueprints/recreatePOST/api/admin/defaults/assets/recreatePOST/api/admin/defaults/themes/recreatePOST/api/admin/defaults/forms/recreatePOST/api/admin/defaults/scope-sets/recreatePOST/api/admin/defaults/all/recreate

List default object recreate targets​

GET
/api/admin/defaults/

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"targets": [
  
  
"string"
  
]
}

Playground​

Server
Authorization

Samples​

Admin Push​

Operations​

POST/api/admin-push/enrollment

Receive Enrollment​

POST
/api/admin-push/enrollment

Receive an enrollment token pushed by the admin portal.
Calls back to admin for mutual verification and credential exchange.

Request Body​

application/json
JSON
{
  
"enrollment_token": "string"
}

Responses​

Successful Response

application/json
JSON
[
]

Playground​

Server
Body

Samples​

Metadata​

Operations​

GET/api/meta/routes/filtersGET/api/meta/routes/GET/api/meta/routes/{id}GET/api/meta/scopes/filtersGET/api/meta/scopes/

Get Route filter metadata​

GET
/api/meta/routes/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Audit Logging​

Operations​

GET/api/logging/audit/filtersGET/api/logging/audit/GET/api/logging/audit/{id}DELETE/api/logging/audit/{id}

Get Audit Log filter metadata​

GET
/api/logging/audit/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

System Logging​

Operations​

GET/api/logging/system/filtersGET/api/logging/system/GET/api/logging/system/{id}DELETE/api/logging/system/{id}

Get System Log filter metadata​

GET
/api/logging/system/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Themes​

Operations​

GET/api/themes/activePOST/api/themes/{id_or_name}/activateGET/api/themes/filtersGET/api/themes/POST/api/themes/GET/api/themes/{id}PUT/api/themes/{id}DELETE/api/themes/{id}PATCH/api/themes/{id}

Get active theme​

GET
/api/themes/active

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"is_active": true,
  
"dark_active": true,
  
"colors": {
  
  
"additionalProperties": "string"
  
},
  
"images": {
  
  
"additionalProperties": "string"
  
},
  
"colors_dark": {
  
  
"additionalProperties": "string"
  
},
  
"images_dark": {
  
  
"additionalProperties": "string"
  
},
  
"control": {
  
  
"system": false,
  
  
"readonly": false,
  
  
"protected": false,
  
  
"hidden": false
  
},
  
"custom": {
  
  
"additionalProperties": "string"
  
},
  
"custom_dark": {
  
  
"additionalProperties": "string"
  
}
}

Playground​

Server
Authorization

Samples​

Mail Templates​

Operations​

GET/api/mailtemplates/filtersGET/api/mailtemplates/POST/api/mailtemplates/GET/api/mailtemplates/{id}PUT/api/mailtemplates/{id}DELETE/api/mailtemplates/{id}PATCH/api/mailtemplates/{id}

Get Mail Template filter metadata​

GET
/api/mailtemplates/filters

Returns metadata about available filters, operators, and sorting options
for this model. This endpoint helps frontend applications dynamically
build filter and sort UIs.

Authorizations​

OAuth2PasswordBearer
password Flow
Token URL"/api/login/access-token"
Scopes:
or
APIKeyHeader
Type
API Key (header: X-API-Key)

Responses​

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground​

Server
Authorization

Samples​

Powered by VitePress OpenAPI