Download OpenAPI specification:Download
The shop service implements all shop functions for GroupAlarm
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API-TOKEN |
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Personal-Access-Token |
Returns all available features
all available features
Unexpected database error
[- {
- "category": "string",
- "categoryDisplayName": "string",
- "color": "string",
- "defaultPrice": 0,
- "description": "string",
- "directTerminationAvailable": true,
- "displayName": "string",
- "icon": "string",
- "markedForDeactivation": true,
- "name": "string"
}
]
Returns all enabled features
organization_id required | int64 requested organization |
all enabled features
no or invalid organization_id in request
unauthorized user
unexpected database error
[- {
- "category": "string",
- "categoryDisplayName": "string",
- "color": "string",
- "defaultPrice": 0,
- "description": "string",
- "directTerminationAvailable": true,
- "displayName": "string",
- "icon": "string",
- "markedForDeactivation": true,
- "name": "string"
}
]
Enables a feature for the given organization
organization_id required | int64 requested organization |
feature_name required | string requested feature |
feature successfully enabled
no or invalid organization_id / feature_name in request
unauthorized user
billing not enabled
unexpected database error
Disables a feature for the given organization
organization_id required | int64 requested organization |
feature_name required | string requested feature |
feature successfully disabled
no or invalid organization_id / feature_name in request
unauthorized user
billing not enabled
unexpected database error