Skip to main content
POST
/
api
/
v3
/
groups
Create a user group
curl --request POST \
  --url https://paradigm.lighton.ai/api/v3/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": 123,
  "company_id": 123,
  "category": "<string>",
  "name": "<string>",
  "description": "<string>",
  "user_ids": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

company_id
integer

Company ID (only for SysAdmin/instance-level users)

Body

V3 API: Create a new user group

name
string
required

Name of the group

Maximum string length: 255
description
string | null

Description of the group

user_ids
integer[]

List of user IDs to add to the group as members

Response

V3 Response serializer for group creation. Returns basic group information with user IDs.

id
integer
required
company_id
integer
required
category
string
required
name
string
required
description
string
required
user_ids
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required