Search Organization

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

Each user belongs to precisely 1 organization (company or association). Billing plans and invoices are managed on the organization-level. Several things are restricted within an organization. For example a user can't list users from another organization and dashboards/datasets are by default not accessible to other users. However, in case it is necessary to share securables cross organization, securables can be associated directly to a user or group.

Retrieve your organization.

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:
Organization Member
Can be associated to:
Country
Locale
Plugin
Thumbnail
User
Create Organization
Update Organization
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('organization',
  {
    where: {
      id: "<your organization id>"
    },
    include: [
      
      {
        model: "User"
      }
    ],
    order: [
      
      [
        
        {
          model: "User"
        },
        "name",
        "asc"
      ]
    ]
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "count": 1,
  "rows": [
    {
      "id": "< your organization id >",
      "name": {
        "nl": "Jouw organisatie",
        "en": "Your organization",
        "fr": "Ton association"
      },
      "users": [
        {
          "email": "amy@test.com",
          "name": "Amy Evans",
          "city": null,
          "country_id": null,
          "locale_id": "en",
          "created_at": "2020-01-01T11:11:27.370Z",
          "flag_plan": "enterprise",
          "id": "b9c8c05a-4a76-11eb-b378-0242ac130002",
          "organizationRole": {
            "flagMember": true,
            "flagEditor": true,
            "flagOwn": false,
            "created_at": "2020-01-01T11:11:27.649Z",
            "updated_at": "2020-09-19T15:44:32.513Z",
            "organization_id": "< your organization id >",
            "user_id": "b9c8c05a-4a76-11eb-b378-0242ac130002"
          }
        },
        {
          "email": "david@test.com",
          "name": "David Contorence",
          "city": null,
          "country_id": null,
          "locale_id": "en",
          "created_at": "2020-01-01T11:11:27.370Z",
          "flag_plan": "enterprise",
          "id": "b33b2d5b-da2b-4eac-8bfd-846bd59f5b2d",
          "organizationRole": {
            "flagMember": true,
            "flagEditor": true,
            "flagOwn": false,
            "created_at": "2020-01-08T13:34:17.461Z",
            "updated_at": "2020-11-10T09:31:17.117Z",
            "organization_id": "< your organization id >",
            "user_id": "b33b2d5b-da2b-4eac-8bfd-846bd59f5b2d"
          }
        },
        {
          "email": "julia@test.com",
          "name": "Julia Robinson",
          "city": null,
          "country_id": null,
          "locale_id": "en",
          "created_at": "2020-01-01T11:11:27.370Z",
          "flag_plan": "enterprise",
          "id": "fc3801a2-cd12-4a9a-ae65-ba7e81b37a4b",
          "organizationRole": {
            "flagMember": true,
            "flagEditor": true,
            "flagOwn": false,
            "created_at": "2019-11-10T10:14:42.355Z",
            "updated_at": "2020-05-29T08:32:25.412Z",
            "organization_id": "< your organization id >",
            "user_id": "fc3801a2-cd12-4a9a-ae65-ba7e81b37a4b"
          }
        }
      ]
    }
  ]
}