Skip to main content
GET
/
api
/
v3
/
groups
List user groups
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/groups \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "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"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

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 to filter groups (only for Admin/Sys Admin/Account Manager)

​
page
integer

Page number (default: 1)

​
per_page
integer

Items per page (default: 20, max: 100)

​
search
string

Filter by group name (case-insensitive)

​
user_id
integer

User ID to filter groups

Response

List of groups with pagination (wrapped in 'data' field with 'pagination' metadata)

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"