List user groups

This endpoint allows users to list groups based on their permissions.

Access levels:

• Admin/Sys Admin/Account Manager: Can view all groups across companies
• Admin DPO: Read-only access to all groups across companies
• Company Admin: Can view all groups in their company
• Company DPO: Read-only access to groups in their company
• Group members: Read-only access to groups they are members of in their company

The has_role filter can be combined with user_id to return only groups where the specified user has a particular role (e.g. owner). It has no effect without user_id.

Supports pagination and search functionality.

GET /api/v3/groups

List user groups

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/groups \
  --header 'Authorization: Bearer <token>'

200

{
  "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

category · enum<string>

Filter by group category: 'company', 'private', or 'custom' (team).

Available options: company, custom, private

company_id · integer

Company ID to filter groups (only for Admin/Sys Admin/Account Manager)

has_role · enum<string>

Filter groups by the role the user (specified via user_id) has in them. Has no effect without user_id.

Available options: member, owner

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

200

application/json

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

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

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

previous · string<uri> | null

Example:

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