Shop API specification (2.10.0)

Download OpenAPI specification:Download

The shop service implements all shop functions for GroupAlarm

Authentication

API_Token

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

Personal-Access-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

featureRegistry

ListAllFeatures

Returns all available features

Responses

200

all available features

500

Unexpected database error

get /
https://app.groupalarm.com/api/v1/shop/

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

features

ListEnabled

Returns all enabled features

query Parameters
organization_id
required
int64

requested organization

Responses

200

all enabled features

400

no or invalid organization_id in request

401

unauthorized user

500

unexpected database error

get /features
https://app.groupalarm.com/api/v1/shop/features

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

EnableFeature

Enables a feature for the given organization

query Parameters
organization_id
required
int64

requested organization

feature_name
required
string

requested feature

Responses

200

feature successfully enabled

400

no or invalid organization_id / feature_name in request

401

unauthorized user

403

billing not enabled

500

unexpected database error

post /features
https://app.groupalarm.com/api/v1/shop/features

DisableFeature

Disables a feature for the given organization

query Parameters
organization_id
required
int64

requested organization

feature_name
required
string

requested feature

Responses

200

feature successfully disabled

400

no or invalid organization_id / feature_name in request

401

unauthorized user

403

billing not enabled

500

unexpected database error

delete /features
https://app.groupalarm.com/api/v1/shop/features