Skip to main content
GET
List groups

Authorizations

Authorization
string
header
required

Authorization: Bearer YOUR_API_KEY. /v2 accepts no other method.

Query Parameters

Partial match across the group name and your own identifier.

type
string

Filter by group type.

user_id
integer

Only groups this end-user belongs to.

sort
enum<string>
default:updated
Available options:
name,
type,
weight,
mrr,
created,
updated,
stats_users,
stats_feedback,
stats_votes,
stats_comments,
stats_satisfaction,
stats_promoter,
stats_active
sort_dir
enum<string>
default:desc
Available options:
asc,
desc
page
integer
default:0
per_page
integer
default:30
Required range: 1 <= x <= 100

Response

OK

status
string
data
object