Summary

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

API Stability Preview

Syntax

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

For the input, you'll have to give text by which to search organization names. You'll have to specify how much to limit and skip results. You can sort results returned based on the type of organization link, and in ascending or descending order. See the Input Parameters section for details.

For the results, you can get a count of the results, the unique identifier and name of the child organizations — which you can use with other query and mutation fields to learn more about a specific sub-organization, as well as make changes.

Example

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

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 } } }
}"
}
);


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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "childOrganizations": {
      "totalResults": 1,
      "results": {
         "id": "abc123",
         "name": "junior",
         "searchDomains": { "id": "xyz789" }
         "stats": { userCount: 12 }
      }
    }
  }
}

Input Parameters

You may provide text by which to search organization names. You'll have to specify how much to limit and skip results. You can sort results returned based on the type of organization link (see second table below), and in ascending or descending order (see third table).

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this query. Since some of the parameters use special datatypes, additional tables for them are included below.
limit integer yes 50 The maximum number of results to return.
orderBy OrderBy   ASC The order in which the results are returned. See table below.
search string     Text by which to search organization name.
skip integer yes 0 Number of results to skip.
sortBy OrganizationsLinks__SortBy   Name Basis for sorting organizational links. See table below.

As mentioned above, you can sort results based on the type of organization link. The table below provides an enumerated list of choices:

Table: OrganizationsLinks__SortBy Enum Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for 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.

The other special datatype used is a simple one. You can return results based on whether they are in ascending or descending order, alphanumerically.

Table: OrderBy Enum Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for 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 Values

For the results, besides a count, there's a sub-choice about the child organization: the unique identifier and name of the child organizations — which you can use with other query and mutation fields to learn more about a specific sub-organization, as well as make changes.

Table: ChildOrganizationsResultSet Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 24, 2024
results[Organization]yes PreviewThe paginated result set. See Organization.
totalResultsintegeryes PreviewThe total number of matching results.

The datatype above uses another datatype for organization information. For your convenience, the table for that sub-datatype is included here:

Table: Organization Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Aug 21, 2025
cidstring  Short-TermThe CID corresponding to the organization.
configsOrganizationConfigsyes Short-TermOrganization configurations and settings. See OrganizationDetails.
createdAtlong  Short-TermDate organization was created.
defaultCachePolicyCachePolicy  PreviewThe default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
deletedAtlong  Short-TermDay organization was deleted if it was marked for deletion.
descriptionstring  Short-TermThe description for the Organization. Can be null.
detailsOrganizationDetailsyes Short-TermAny additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationbooleanyes Short-TermWhether there is group synchronization.
externalPermissionsbooleanyes Short-TermWhether permissions are managed externally.
idstringyes Short-TermThe unique id for the Organization.
ingestUrlstring  Short-TermThe ingest URL for the organization.
isActionAllowed(action: OrganizationAction): booleanmultipleyes Short-TermCheck if user has a permission in organization. For OrganizationAction, give the action to check if a user is allowed to perform on the organization. See OrganizationAction.
limits[Limit]yes Short-TermLimits assigned to the organization. See Limit.
limitsV2[LimitV2]yes Short-TermLimits assigned to the organization. See LimitV2.
namestringyes Short-TermThe name for the Organization.
publicUrlstring  Short-TermThe public URL for the organization.
readonlyDashboardIPFilterstring  Short-TermIP filter for readonly dashboard links.
searchDomains[SearchDomain]yes Short-TermSearch domains within the organization. See SearchDomain.
statsOrganizationStatsyes Short-TermStatistics of the organization. See OrganizationStats.
trialStartedAtlong  Short-TermDate organization's trial started.