Get NotionUser - fasteiner/Notion GitHub Wiki


Category: Commands external help file: Notion-help.xml Module Name: Notion online version: https://developers.notion.com/reference/get-user schema: 2.0.0 Type: Command

Get-NotionUser

SYNOPSIS

Retrieves information about a specific Notion user.

SYNTAX

Get-NotionUser [[-UserId] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The `Get-NotionUser` function retrieves details about a specific user from Notion by making a GET request to the Notion API's `/v1/users/{user_id}` endpoint, utilizing the `Invoke-NotionApiCall` function.

EXAMPLES

EXAMPLE 1

$userId = "12345-67890-abcd-efgh"
Get-NotionUser -UserId $userId

This example retrieves information about the specified user from the Notion API.

PARAMETERS

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserId

The unique identifier of the Notion user. Possible values: '`$null' (list all users) or 'me' (the API User) or a user ID.

Type: String
Parameter Sets: (All)
Aliases: Id

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

  • Ensure that the Notion API integration has the necessary permissions to access user information.
  • The API token and version are handled within the `Invoke-NotionApiCall` function.

RELATED LINKS

https://developers.notion.com/reference/get-user

⚠️ **GitHub.com Fallback** ⚠️