notion.querydatabaseprops
Home > @runlightyear/notion > QueryDatabaseProps
QueryDatabaseProps interface
Signature:interface QueryDatabaseProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| databaseId | NotionId | Identifier for a Notion database. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| filter? | Filter | When supplied, limits which pages are returned based on the filter conditions. | |
| filterProperties? | string | (DOES NOT WORK YET) A list of page property value IDs associated with the database. Use this param to limit the response to a specific page property value or values for pages that meet the filter criteria. | |
| pageSize? | number | The number of items from the full list desired in the response. Maximum: 100 | |
| sorts? | Array<SortCriteria> | When supplied, orders the results based on the provided sort criteria. | |
| startCursor? | string | When supplied, returns a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results. |