Browse Groups

The browse groups endpoint lists all the customer-configured groups present in the latest index. The browse groups endpoint does not return individual item results - for this purpose reference the standard browse endpoint.

Request all groups
curl -X GET -H "Content-Type: application/json" \
"https://ac.cnstrc.com/browse/groups?key=[your API key]"
Request a single group
curl -X GET -H "Content-Type: application/json" \
"https://ac.cnstrc.com/browse/groups?filters[group_id]=[your group id]"

HTTP Request#

GET https://ac.cnstrc.com/browse/groups?filters[group_id]=[your group id]&key=[your API key]&fmt_options[groups_max_depth]=5

URL Parameters#

The URL parameters the endpoint accepts are shown below.

OptionRequired?DefaultDescription
filters[group_id]Non/aThe id of the specific group that should be included in the response
fmt_options[groups_max_depth]No1In case of hierarchical groups, maximum depth of the hierarchy that should be included in the response

Response format overview#

{
"request": {
...
},
"response": {
"groups": [
{
"children": [
{
"children": [],
"count": 1,
"data": null,
"display_name": "Dog food",
"group_id": "dog-food",
"parents": [
{
"display_name": "Pet food",
"group_id": "pet-food"
}
]
}
],
"count": 2,
"data": null,
"display_name": "Pet food",
"group_id": "pet-food",
"parents": []
},
{
"children": [],
"count": 2,
"data": null,
"display_name": "Pet toys",
"group_id": "pet-toys",
"parents": []
}
]
}
}