Search Collection

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/collection

API call form

Examples

List of examples

Get collection by ID
Get collection by name
Get collection with users and groups that can access
Get collection and the users and groups
Get collection, dashboards, datasets and EmbedFilters

Description

Get a collection by ID and the users and groups that can access it. For each group, get the users that are part of it.

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

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('collection',
  {
    where: {
      id: "< collection ID >"
    },
    attributes: [
      "id",
      "name"
    ],
    include: [
      {
        model: "User",
        attributes: [
          "id"
        ]
      },
      {
        model: "Group",
        attributes: [
          "id"
        ],
        include: [
          {
            model: "User",
            attributes: [
              "id"
            ]
          }
        ]
      },
      {
        model: "Securable",
        attributes: [
          "id"
        ]
      }
    ]
  }
);