v1

latestOpenAPI 3.0.02026-07-2480129136.5 KB
Catalog

List All Groups Details

This endpoint returns all groups that match the specified criteria.

get/catalog/groups

Query parameters

categoryIdinteger

If specified, only return groups from this category.

categoryNamestring

If specified, only return groups from categories with this exact name.

isSupplementalboolean

If true, only return supplemental groups. If false, return only non-supplemental groups. Otherwise, return all groups regardless of whether they are supplemental or not.

hasSealedboolean

If true, only return groups that contain sealed product. If false, only return groups that do not contain sealed product. Otherwise, return all groups regardless of whether they have sealed product or not.

sortOrderstring

The name of the property to sort the returned groups by. Default is GroupName.

sortDescboolean

If true then sort descending, otherwise sort ascending.

offsetinteger

Used for paging. The number of groups to skip. Default is 0.

limitinteger

Used for paging. The maximum number of groups to return. Default is 10.

Response

Groups found and returned.

totalItemsinteger
successboolean
errorsstring[]