v1
latestOpenAPI 3.1.02026-07-1451089.2 KBList all groups in a saved view
Boxes in a saved view may be grouped together. The default grouping for most saved views is by stage, though when setting up a saved view you can also group by any other column, such as the user a box is assigned to.
The results include a groupByKeyEncoded property which you can use to retrieve the individual boxes in a saved view group, as well as the count property, indicating how many boxes exist in this group.
get/pipelines/{pipelineKey}/views/{viewKey}/groups
Path parameters
pipelineKeystring required
The key of the pipeline
viewKeystring required
The key of the saved view
Query parameters
modeinteger
Provide "1" to use new implementation of the endpoint that supports "Not Set" groups
Response
200
Example response
{
"results": [
{
"groupByKey": "5001",
"groupByKeyEncoded": "NTAwMQ",
"groupByValue": "New",
"count": 2
}
]
}