API Stability Long-Term

The pendingUsers() GraphQL query will return the pending users. You can filter the results by including a search string.

For more information on user authorization, see the Manage Users and Permissions documentation page.

Syntax

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

graphql
pendingUsers(
     search: string
   ): [PendingUser]!

There are no special input datatypes for this query field. Below is an example using it:

Raw
graphql
query {
  pendingUsers(search:"company.com") {
    newUserEmail
  }
}
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 {
  pendingUsers(search:\"company.com\") {
    newUserEmail
  }
}"
}
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 {
  pendingUsers(search:\"company.com\") {
    newUserEmail
  }
}"
}
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 { ^
  pendingUsers(search:\"company.com\") { ^
    newUserEmail ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  pendingUsers(search:\"company.com\") {
    newUserEmail
  }
}"
}'
    "$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 {
  pendingUsers(search:\"company.com\") {
    newUserEmail
  }
}";
$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 {
  pendingUsers(search:\"company.com\") {
    newUserEmail
  }
}"
}'''

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 {
  pendingUsers(search:\"company.com\") {
    newUserEmail
  }
}"
}
);


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": {
    "pendingUsers": [
     "newUserEmail": "joe@company.com"
    ]
 }
}

Given Datatypes

For the given datatype, PendingUser, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: PendingUser

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: Mar 26, 2025
createdAtlongyes Long-TermThe time the pending user was created.
idstringyes Long-TermThe identifier or token for the pending user.
idpbooleanyes Long-TermWhether IdP is enabled for the organization.
invitedByEmailstringyes Long-TermThe email address of the user that invited the pending user.
invitedByNamestringyes Long-TermThe name of the user that invited the pending user.
newUserEmailstringyes Long-TermThe email of the pending user.
orgNamestringyes Long-TermThe name of the organization for the pending user.
pendingUserStatePendingUserStateyes Long-TermThe current organization state for the user. See PendingUserState.