try out ↗

← API Index


/api/system/actiongroups

Lists the action groups (aka Aktionsgruppen) of this shop, with a member flag indicating whether the authenticated customer belongs to each group. Customers and guests get the customer-editable groups (edittype=2) only; backend-only (0) and shop-only (1) groups are filtered out. Admins and callers with the statistics permission get all groups, each with its memberCount.

Parameters

Name Description Type
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
ActionGroup 1 (aka Actionsgruppe), an arbitrary customer grouping used for automation, marketing or segmentation

OpenAPI

See actiongroups.yaml

Referenced in skills