API Stability Preview

The childOrganizations() GraphQL query is used to get a list of linked child organizations. This is not supported when using organizations in single mode. This query field is a preview and subject to changes.

Syntax

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

graphql
childOrganizations(
     search: string, 
     skip: integer!,
     limit: integer!,
     orderBy: OrderBy, 
     sortBy: OrganizationsLinks__SortBy
   ): ChildOrganizationsResultSet!

Below is an example of how you might use this query:

Raw
graphql
query {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}
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 {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}
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 {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}
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 { ^
	childOrganizations(skip: 0, limit: 10) ^
  {totalResults, results { ^
    id, name, searchDomains { ^
      id ^
    }, stats {userCount, dataVolume} ^
  }} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "query {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
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 {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}'''

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 {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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();

For the input's special datatype, the values are given within curly-brackets. As for the returned results, a list of requests is entered in a comma-separated list, also within curly-brackets — and again for sub-selections.

Given Datatype

For OrganizationsLinks__SortBy, there are a few parameters. They're listed here along with descriptions of each:

Table: OrganizationsLinks__SortBy

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Jul 25, 2025
Cid   PreviewSort by CID for the organization.
OrgId   PreviewSort by the unique identifier for the organization.
Name  ✓PreviewSort by the name of the organization.

For OrderBy, there are a few parameters. They're listed here along with descriptions of each:

Table: OrderBy

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 10, 2025
ASC  ✓Long-TermOrder results in ascending order (e.g., 0 to 9, A to Z).
DESC   Long-TermOrder results in descending order (e.g., 9 to 0, Z to A).

Returned Datatype

For ChildOrganizationsResultSet, there are a couple possible values returned, which are listed below. One of them leads to more sub-choices.

Table: ChildOrganizationsResultSet

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 24, 2024
results[Organization]yes PreviewThe paginated result set. See Organization.
totalResultsintegeryes PreviewThe total number of matching results.