GET /api/sales-channels/groups — vivenu-api

latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api

sales-channels

Get all sales channel groups

get/api/sales-channels/groups

statusstring[]

Filter sales channel groups by status

namestring

Filter sales channel groups by name

includeDefaultGroupsboolean

Whether default groups should be included

topinteger

A limit on the number of objects to be returned. Can range between 1 and 1000.

skipinteger

The number of objects to skip for the requested result

namestring required

The name of the sales channel group

status'ACTIVE' | 'INACTIVE' required

The status of the sales channel group, whether it is active or not

salesChannelIdsstring[]

The sales channels that are in the group

restrictEventAccessboolean required

Wether channels in this group can only access some events or all

_idstring required

The ID of the sales channel group

sellerIdstring required

The ID of the seller of the sales channel group

createdAtstring date-time

An ISO timestamp indicating when the sales channel group was created

updatedAtstring date-time

An ISO timestamp indicating when the sales channel group was updated