Skip to content
Arsen API Documentation

List all groups

GET
/v1/groups

Returns a list of standard and dynamic groups previously created. The groups are returned in sorted order, with the most recent appearing first.

Parameters

Query Parameters

select
string format: select=field,field
default: All fields
Allowed values: name type score employeeCount identityDirectory createdAt 
select=name,type

Comma-separated list of fields to include in the response. Field ID is always selected

filter

Fields to filter results, separated by & and operator separated by :. Fields can be repeated to filter by multiple values

object
field
string
Allowed values: name type score employeeCount identityDirectory createdAt
operator
string
Allowed values: $eq $ne $gt $lt $gte $lte
value
string
filter[type]=$eq:standard&filter[score]=$gt:60
sort
string format: sort[field]=direction
Allowed values: name type score employeeCount identityDirectory createdAt 
sort[name]=desc

Fields to sort result, separated by &. Direction can be asc or desc

page
number
default: 1 
page=2

Page number to retrieve

limit
number
default: 100 
limit=10

Number of item per page

Responses

200

object
status
required
string
Allowed values: success
pagination
required
object
data
required
object
groups
required
Array<object>
object
id
required
string
name
string
type

Whether the group is standard or if the employees in the group are updated automatically according to a set of rules.

string
Allowed values: standard dynamic
score

The computed score of all targets in the group. Null if the no campaign is completed.

number
nullable <= 100
employeeCount
number
identityDirectory

The identity directory provider with whom the group is sync. Null if the group is not synchronized.

string
nullable
Allowed values: microsoft google
createdAt
string format: date-time

400

Bad request

object
error
string
statusCode
required
number

401

Unauthorized

object
message
required
string
statusCode
required
number

408

Request timeout

object
message
required
string
statusCode
required
number

429

Too many requests

object
message
required
string
statusCode
required
number

500

Internal server error

object
message
required
string
statusCode
required
number