Get NotionDatabase - fasteiner/Notion GitHub Wiki


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

Get-NotionDatabase

SYNOPSIS

Retrieves a Notion database structure (not the data) by its ID.

SYNTAX

Get-NotionDatabase [-DatabaseId] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-NotionDatabase function calls the Notion API to retrieve a database using the provided DatabaseId. It sends a GET request to the Notion API and converts the response to a notion_database object.

EXAMPLES

EXAMPLE 1

Get-NotionDatabase -DatabaseId "your-database-id"
PS C:\> Get-NotionDatabase -id "your-database-id"
PS C:\> Get-NotionDatabase "your-database-id"

This command retrieves the Notion database structure with the specified ID.

PARAMETERS

-DatabaseId

The unique identifier of the Notion database to retrieve.

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

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

-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

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

notion_database

NOTES

RELATED LINKS

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