The organization() GraphQL query is used to get the current organization.

For more information on organization settings, see the Organization Settings documentation page.

Syntax

Below is the syntax for the organization() query field:

graphql
organization: Organization!

Enter organization followed by which values you want in a comma-separated list within curly-brackets as shown in the example below:

Raw
graphql
query {
  organization {
    id, name, 
    stats{userCount}
  }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  organization {
    id, name, 
    stats{userCount}
  }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  organization {
    id, name, 
    stats{userCount}
  }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  organization { ^
    id, name,  ^
    stats{userCount} ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  organization {
    id, name, 
    stats{userCount}
  }
}"
}'
"$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  organization {
    id, name, 
    stats{userCount}
  }
}"
}';
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  organization {
    id, name, 
    stats{userCount}
  }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  organization {
    id, name, 
    stats{userCount}
  }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "organization": {
      "id": "SINGLE_ORGANIZATION_ID",
      "name": "SingleOrganization",
      "stats": {
        "userCount": 13
      }
    }
  }
}

Notice in the example above, besides calling for the id and name of the organization, stats is given, with the sub-choice userCount to get the number of users.

Given Datatypes

The given datatype organization() has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: Organization

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique id for the Organization.
namestringyes The name for the Organization.
descriptionstring  The description for the Organization. Can be null.
detailsOrganizationDetailsyes Any additional details related to the organization (see OrganizationDetails Table).
statsOrganizationStatsyes Statistics of the organization (see OrganizationStats Table).
configsOrganizationConfigsyes Organization configurations and settings (see OrganizationDetails Table).
searchDomains[SearchDomain]yes Search domains within the organization (see SearchDomain Table).
readonlyDashboardIPFilterstring  IP filter for readonly dashboard links.
createdAtlong  Date organization was created.
trialStartedAtlong  Date organization's trial started.
isActionAllowedtypeyes Check if current user has a given permission in organization. OrganizationAction is the action to check if a user is allowed to perform on an organization (see OrganizationAction Table).
limits[Limit]yes Limits assigned to the organization (see Limit Table).
externalPermissionsbooleanyes Whether permissions are managed externally.
externalGroupSynchronizationbooleanyes Whether there is group synchronization.
defaultCachePolicyCachePolicy  The default cache policy of this organization. PREVIEW: Cache policies are a limited feature and is subject to change. See CachePolicy Table.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.