Groups

Download OpenAPI specification:Download

Manage user groups

Create group

Create a group for your users.

Required permissions: apps:create, [appId]:create, groups:create.

SecurityOAuth2: ClientAccessToken
Request
Request Body schema: application/json
required
name
required
string

Name of the group to create

description
string
custom_data
object

Group custom data object

Responses
201
409
post/v1/groups
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "custom_data": { }
}
Response samples
application/json
{
  • "result": {
    }
}

Get groups

Retrieve a list of all groups.

Required permissions: apps:read, [appId]:read, groups:read, apps:list, [appId]:list, groups:list.

SecurityOAuth2: ClientAccessToken
Responses
200
400
get/v1/groups
Request samples 
Response samples 
application/json
{
  • "result": [
    ]
}
Get group by ID
Retrieve a group by ID. 

Required permissions: apps:read, [appId]:read, groups:read.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
group_id
required
string
ID of the group to retrieve


 
Responses 
200
404
get/v1/groups/{group_id}
Request samples 
Response samples 
application/json
{
  • "result": {
    }
}
Update group
Update a group for your users. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one. 

Required permissions: apps:edit, [appId]:edit, groups:edit.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
group_id
required
string
The ID of the group that should be updated


 
Request Body schema: application/json
required
name
string
Name of the group to update


 
description
string
 
custom_data
object
Group custom data object


 
Responses 
200
400
404
put/v1/groups/{group_id}
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "custom_data": { }
}
Response samples 
application/json
{
  • "result": {
    }
}
Delete group
Delete a group. 

Required permissions: apps:delete, [appId]:delete, groups:delete.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
group_id
required
string
ID of the group to delete


 
Responses 
204
Group removed.


400
404
delete/v1/groups/{group_id}
Request samples 
Response samples 
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}
Add users to group
Add one or more users as members of a group. 

Required permissions: apps:edit, [appId]:edit, groups:edit.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
group_id
required
string
ID of the group to assign the users to


 
Request Body schema: application/json
required
user_ids
required
Array of strings
ID of the users to assign to the group


 
Responses 
204
Assigned users to group.


400
404
post/v1/groups/{group_id}/members
Request samples 
application/json
{
  • "user_ids": [
    ]
}
Response samples 
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}
Get group's users
Retrieve all users that are members of a specific group. 

Required permissions: apps:read, [appId]:read, users:read.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
group_id
required
string
ID of the group to retrieve users for


 
Responses 
200
400
404
get/v1/groups/{group_id}/members
Request samples 
Response samples 
application/json
{
  • "result": [
    ]
}
Remove user from group
Remove a user from a group. 

Required permissions: apps:edit, [appId]:edit, groups:edit.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
group_id
required
string
Group ID


 
user_id
required
string
User ID


 
Responses 
204
Removed user from group.


400
404
delete/v1/groups/{group_id}/members/{user_id}
Request samples 
Response samples 
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}