Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Item groups

Retrieve item group

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

Retrieve an item group.

get/v2/item_groups/{item_group_id}

Path parameters

item_group_idstring required

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
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

Response

OK

dataobject

Object containing additional data, that should be attached to this item group. The maximum size of data object is limited to 5kB. The average size of data objects for all ingested item groups should not exceed 1kB.

idstring required

The ID of the item group

namestring required

Item group display name.

parent_idsstring[]

List of parent item group IDs

Example response

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