v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Item groups

Retrieve item groups

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: catalog(r).

Retrieve all items groups, optionally filtered by ids.

get/v2/item_groups

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

idstring[]

Array of item group ID(s) to filter by.

num_results_per_pageinteger

The number of results per page to return.

Example:20

pageinteger

The page of results to return.

Example:1

offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

total_countinteger required

Total number of item groups.

{
  "item_groups": [
    {
      "parent_ids": [
        "parent-1"
      ]
    }
  ]
}