Search Group

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/group

Division or group within or across the bounds of organizations. Groups have administrators and members and can be assigned access rights to datasets or dashboards. The creating user of a group is automatically given group owner rights. Groups can be created by any user. Only group owners can update or delete a group, or associate or dissociate new group members.

Groups can only be retrieved by group members or owner. They are linked to Securables (Dashboard/Dataset) and users which can be included in the results. For example we could do a query to get all members of a group or retrieve all securables that a group has access to. Note that you will only receive the included entities to which you have access, for example you will only receive users in the group that are in your organization. Although you can add users outside of your organization to a group, you can not list their details.

Parameters
Expand all Reset
find *OBJECTrequired
where OBJECT
search OBJECT
include ARRAY[OBJECT]
attributes ARRAY[STRING]
order ARRAY
limit NUMBER
offset NUMBER
Can be executed by:
Group Member
Can be associated to:
Dashboard
Dataset
User
Organization
Collection
Create Group
Update Group
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.get('group',
  {
    where: {
      id: "< group id >"
    },
    include: [
      
      {
        model: "User"
      },
      
      {
        model: "Securable"
      }
    ]
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "count": 1,
  "rows": [
    {
      "id": "f5aff911-94fc-45f3-9de2-68e3a0a82334",
      "name": {
        "en": "MyGroup"
      },
      "created_at": "2018-08-28T10:12:23.625Z",
      "updated_at": "2018-08-28T10:12:23.625Z",
      "deleted_at": null,
      "public": false,
      "open": false,
      "users": [
        {
          "email": "someuser1@luzmo.com",
          "name": "Mr Unit McTestFace",
          "city": "SmallUnitVille",
          "country_id": null,
          "locale_id": "en",
          "created_at": "2018-08-28T10:12:22.563Z",
          "id": "a7a900a2-b14e-49cc-94ea-7b034407be86",
          "groupRole": {
            "flagMember": true,
            "flagOwn": true,
            "created_at": "2018-08-28T10:12:23.631Z",
            "updated_at": "2018-08-28T10:12:23.631Z",
            "user_id": "a7a900a2-b14e-49cc-94ea-7b034407be86",
            "group_id": "f5aff911-94fc-45f3-9de2-68e3a0a82334"
          }
        },
        {
          "email": "someuser2@luzmo.com",
          "groupRole": {
            "flagMember": true,
            "flagOwn": false
          }
        },
        {
          "email": "someuser3@luzmo.com",
          "groupRole": {
            "flagMember": true,
            "flagOwn": false
          }
        }
      ],
      "securables": [
        {
          "id": "c5f4a9ab-bace-485e-aeeb-a89ea76502b5",
          "type": "dataset",
          "subtype": "api",
          "name": {
            "en": "SalesProfitCost2004.csv"
          },
          "description": null,
          "modifier_id": "a7a900a2-b14e-49cc-94ea-7b034407be86",
          "owner_id": "a7a900a2-b14e-49cc-94ea-7b034407be86",
          "groupAccessRight": {
            "flagRead": true,
            "flagUse": false,
            "published": false,
            "filters": null,
            "group_id": "f5aff911-94fc-...",
            "securable_id": "17866361-79f..."
          }
        },
        {
          "id": "17866361-79f7-4268-ba9f-a2eb5facd01d",
          "groupAccessRight": {}
        }
      ]
    }
  ]
}