The pendingUsers() GraphQL query will return the pending users.

For more information on user authorization, see the Manage users & permissions documentation page.

Syntax

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

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

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

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 27, 2024
createdAtlongyes The time the pending user was created.
idstringyes The identifier or token for the pending user.
idpbooleanyes Whether IdP is enabled for the organization.
invitedByEmailstringyes The email address of the user that invited the pending user.
invitedByNamestringyes The name of the user that invited the pending user.
newUserEmailstringyes The email of the pending user.
orgNamestringyes The name of the organization for the pending user.
pendingUserStatePendingUserStateyes The current organization state for the user. See PendingUserState.