GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Get Smart Groups

Get Smart Groups

Query Params
integer
Defaults to 0
integer
Defaults to 100
sort
array of strings
Defaults to groupId:asc

Sorting criteria in the format: property:asc/desc. Default sort is id:asc. Available criteria to sort on: groupId, groupName, siteId.

sort
string

Query in the RSQL format, allowing to filter smart group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName=="smartGroup1"

Response

Language
Credentials
Response
Choose an example:
application/json