PHPackages pi-space/notion-api-integration - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. pi-space/notion-api-integration ActiveLibrary[API Development](/categories/api) pi-space/notion-api-integration =============================== Easy to use and simple Integration to Notion API. v2.4.0(2y ago)34262MITPHPPHP ^8.1 Since Nov 30Pushed 2y ago1 watchersCompare [ Source](https://github.com/Eyadhamza/Laravel-Notion-Integration)[ Packagist](https://packagist.org/packages/pi-space/notion-api-integration)[ Docs](https://github.com/eyadhamza/notion-api-wrapper)[ GitHub Sponsors](https://github.com/PISpace)[ RSS](/packages/pi-space-notion-api-integration/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (9)Versions (18)Used By (0) Laravel Notion Integration ========================== [](#laravel-notion-integration) --- About ----- [](#about) The Laravel Notion Integration package is a wrapper for the REST API provided by Notion.so. It allows for easy interaction with your Notion workspace, saving you time and effort. This package provides an easy and fluent interface for manipulating pages, databases, users, blocks, and more. Installation ------------ [](#installation) You can install the package via composer: ``` composer require pi-space/notion-api-integration ``` Usage ----- [](#usage) ### Setting Up Notion Workspace [](#setting-up-notion-workspace) In your `.env` file, add your Notion token: ``` NOTION_TOKEN=secret_{token} ``` > To create your first integration, please visit: [Notion Create an integration](https://developers.notion.com/docs/create-a-notion-integration)To obtain your secret token, visit [Notion API](https://developers.notion.com/docs/authorization) ### Handling Notion Databases [](#handling-notion-databases) #### Fetching Notion Database by ID [](#fetching-notion-database-by-id) To fetch a Notion database by ID, use the `find` method of the `NotionDatabase` class. It will return a `NotionDatabase`object containing information such as title, description, and all the database properties. ``` use PISpace\Notion\Core\Models\NotionDatabase; $database = NotionDatabase::make('632b5fb7e06c4404ae12065c48280e4c')->find(); ``` #### Creating a Notion Database [](#creating-a-notion-database) To create a Notion database, use the `NotionDatabase` class and set the required parameters such as parent page ID and properties schema. ``` use PISpace\Notion\Core\Models\NotionDatabase; $database = NotionDatabase::make() ->setParentPageId('fa4379661ed948d7af52df923177028e') ->setTitle('Test Database2') ->buildProperties([ NotionTitle::make('Name'), NotionSelect::make('Status')->setOptions([ ['name' => 'A', 'color' => 'red'], ['name' => 'B', 'color' => 'green'] ]), NotionDate::make('Date'), NotionCheckbox::make('Checkbox'), NotionFormula::make('Formula')->setExpression('prop("Name")'), NotionRelation::make('Relation') ->setDatabaseId($this->databaseId), NotionRollup::make('Rollup') ->setRollupPropertyName('Name') ->setRelationPropertyName('Relation') ->setFunction('count'), NotionPeople::make('People'), NotionMedia::make('Media'), NotionEmail::make('Email'), NotionNumber::make('Number'), NotionPhoneNumber::make('Phone'), NotionUrl::make('Url'), NotionCreatedTime::make('CreatedTime'), NotionCreatedBy::make('CreatedBy'), NotionLastEditedTime::make('LastEditedTime'), NotionLastEditedBy::make('LastEditedBy'), ]) ->create(); ``` #### Updating a Notion Database [](#updating-a-notion-database) To update an existing Notion database, use the `NotionDatabase` class and specify the database ID and updated properties. ``` $database = NotionDatabase::make('a5f8af6484334c09b69d5dd5f54b378f') ->buildProperties([ // Specify the updated properties ]) ->update(); ``` #### Querying a Database [](#querying-a-database) To query a Notion database and get a list of pages contained within the database, you can apply filters and sorting criteria using the `query` method. ``` // Using one filter $paginated = NotionDatabase::make('632b5fb7e06c4404ae12065c48280e4c') ->setFilter(NotionSelect::make('Status')->equals('In Progress')) ->query(); // Using multiple filters with AND operator $pages = $database->setFilters([ NotionFilter::groupWithAnd([ NotionSelect::make('Status')->equals('Reading'), NotionTitle::make('Name')->equals('MMMM') ]) ])->query(); // Using multiple filters with OR operator $pages = $database->setFilters([ NotionFilter::groupWithOr([ NotionSelect::make('Status')->equals('Reading'), NotionTitle::make('Name')->equals('MMMM') ]) ])->query(); // Using Notion Compound Filters $response = $database->setFilters([ NotionFilter::groupWithOr([ NotionSelect::make('Status')->equals('Reading'), NotionFilter::groupWithAnd([ NotionTitle::make('Name')->contains('MMMM'), NotionTitle::make('Name')->contains('EEEE') ]) ]), ])->query(); // Sorting database results $pages = $database->sorts(NotionSort::property('Name')->ascending()) ->query(); // Sort with multiple properties $pages = $database->setSorts([ NotionTitle::make('Name')->ascending(), NotionDate::make('Date')->descending() ])->query(); // Apply sorts and filters together $pages = $database->setSorts([ NotionTitle::make('Name')->ascending(), NotionDate::make('Date')->descending() ])->setFilters([ NotionFilter::groupWithOr([ NotionSelect::make('Status')->equals('Reading'), NotionTitle::make('Name')->equals('MMMM') ]) ])->query(); ``` ### Handling Notion Pages [](#handling-notion-pages) #### Fetching a Page by ID (without the page contents) [](#fetching-a-page-by-id-without-the-page-contents) ``` $page = NotionPage::make('b4f8e429038744ca9c8d5afa93ea2edd')->find(); ``` #### Fetching a Page by ID (with the page contents) [](#fetching-a-page-by-id-with-the-page-contents) ``` $page = NotionPage::make('b4f8e429038744ca9c8d5afa93ea2edd')->findWithContent(); ``` #### Creating a New Notion Page / Notion Database Item [](#creating-a-new-notion-page--notion-database-item) To create a new Notion page or a new item in a Notion database, you can use the `NotionPage` class and set the required properties and their values. ``` $page = NotionPage::make() ->setDatabaseId('a5f8af6484334c09b69d5dd5f54b378f') ->buildProperties([ NotionTitle::make('Name') ->setTitle('Test'), NotionSelect::make('Status') ->setSelected('A'), NotionDate::make('Date') ->setStart('2021-01-01'), NotionCheckbox::make('Checkbox') ->setChecked(true), NotionRelation::make('Relation') ->setPageIds(['633fc9822c794e3682186491c50210e6']), NotionText::make('Password') ->setText('Text'), NotionPeople::make('People') ->setPeople([ NotionUser::make('2c4d6a4a-12fe-4ce8-a7e4-e3019cc4765f'), ]), NotionMedia::make('Media') ->setFiles([ NotionFile::make() ->setFileType('file') ->setRelativeType('external') ->setFileUrl('https://www.google.com'), ]), NotionEmail::make('Email') ->setEmail('eyadhamza0@gmail.com'), NotionNumber::make('Number') ->setNumber(10), NotionPhoneNumber::make('Phone') ->setPhoneNumber('+201010101010'), NotionUrl::make('Url') ->setUrl('https://www.google.com'), ]) ->create(); ``` #### Creating a New Notion Page / Notion Database Item with Content [](#creating-a-new-notion-page--notion-database-item-with-content) ``` $page = NotionPage::make() ->setDatabaseId($this->databaseId) ->buildProperties([ NotionTitle::make('Name', 'Test'), NotionSelect::make('Status') ->setSelected('A'), ])->setBlockBuilder( NotionBlockBuilder::make() ->headingOne(NotionRichText::text('Eyad Hamza') ->isToggleable() ->setBlockBuilder( NotionBlockBuilder::make() ->headingOne(NotionRichText::text('Eyad Hamza') ->bold() ->italic() ->strikethrough() ->underline() ->code() ->color('red') ) ) ->bold() ->italic() ->strikethrough() ->underline() ->code() ->color('red') ) ->headingTwo('Heading 2') ->headingThree('Heading 3') ->numberedList([ 'Numbered List', 'asdasd Numbered List' ]) ->bulletedList(['Bullet List']) ->paragraph('Paragraph') ->toDo(['To Do List']) ->toggle('Toggle') ->quote('Quote') ->divider() ->callout('Callout') ->image(NotionFile::make() ->setFileType('image') ->setFileUrl('https://my.alfred.edu/zoom/_images/foster-lake.jpg') ->setRelativeType('external') ) ->file(NotionFile::make() ->setFileType('file') ->setFileUrl('https://www.google.com') ->setRelativeType('external') ) ->embed('https://www.google.com') ->bookmark('https://www.google.com') ->code(NotionRichText::text('echo "Hello World"')->setCodeLanguage('php')) ->equation('x^2 + y^2 = z^2') ->pdf(NotionFile::make() ->setFileType('pdf') ->setFileUrl('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf') ->setRelativeType('external') ) ->video(NotionFile::make() ->setFileType('video') ->setFileUrl('https://www.youtube.com/watch?v=xTQ7vhtp23w') ->setRelativeType('external') ) )->create(); ``` #### Updating a Page Properties [](#updating-a-page-properties) To update the properties of an existing page, create a `NotionPage` object with the page ID, set the updated properties, and call the `update()` method. ``` $page = NotionPage::make('b4f8e429038744ca9c8d5afa93ea2edd') ->buildProperties([ // Specify the updated properties ])->update(); ``` #### Deleting a Page [](#deleting-a-page) To delete a page, create a `NotionPage` object with the page ID and call the `delete()` method. ``` $page = NotionPage::make('b4f8e429038744ca9c8d5afa93ea2edd')->delete(); ``` ### Handling Notion Blocks [](#handling-notion-blocks) #### Fetching a Block by ID [](#fetching-a-block-by-id) To fetch a Notion block by ID, use the `find` method of the `NotionBlock` class. ``` $block = NotionBlock::make('b4f8e429038744ca9c8d5afa93ea2edd')->find(); ``` #### Fetching Block Children [](#fetching-block-children) To fetch the children blocks of a Notion block, use the `fetchChildren` method. ``` $blockChildren = NotionBlock::make('b4f8e429038744ca9c8d5afa93ea2edd') ->fetchChildren(); ``` #### Updating a Block [](#updating-a-block) To update a Notion block, create a new instance of the `NotionBlock` class, set the updated content, and call the `update()` method. ``` $block = NotionBlock::make('62ec21df1f9241ba9954828e0958da69') ->setType(NotionBlockTypeEnum::HEADING_1) ->setBlockContent(NotionRichText::text('Eyad Hamza')) ->update(); ``` #### Appending Block Children [](#appending-block-children) To append children blocks to a Notion block, use the `createChildren` method. ``` $block = NotionBlock::make('62ec21df1f9241ba9954828e0958da69') ->setBlockBuilder( NotionBlockBuilder::make() ->headingTwo(NotionRichText::text('Eyad Hamza') ->bold() ->setLink('https://www.google.com') ->color('red')) ->headingThree('Heading 3') ->numberedList(['Numbered List']) ->bulletedList(['Bullet List']) )->createChildren(); ``` #### Deleting a Block [](#deleting-a-block) To delete a Notion block, use the `delete` method. ``` $block = NotionBlock::make('62ec21df1f9241ba9954828e0958da69')->delete(); ``` ### Searching [](#searching) You can perform searches in Notion pages or databases using the `NotionSearch` class. #### Searching in Pages [](#searching-in-pages) To search for a specific query in Notion pages, use the `inPages` method of the `NotionSearch` class. You can apply sorting criteria using the `sorts` method. ``` $response = NotionSearch::inPages('Eyad') ->sorts([ NotionLastEditedTime::make()->ascending(), ]) ->apply(50); ``` #### Searching in Databases [](#searching-in-databases) To search for a specific query in Notion databases, use the `inDatabases` method of the `NotionSearch` class. ``` $response = NotionSearch::inDatabases('Eyad')->apply(50); ``` ### Users [](#users) #### Retrieving All Users [](#retrieving-all-users) To retrieve all Notion users, use the `index` method of the `NotionUser` class. ``` $users = NotionUser::make()->index(); ``` #### Retrieving a User by ID [](#retrieving-a-user-by-id) To retrieve a specific Notion user by ID, use the `find` method of the `NotionUser` class. ``` $user = NotionUser::make('2c4d6a4a-12fe-4ce8-a7e4-e3019cc4765f')->find(); ``` #### Retrieving Current Bot Info [](#retrieving-current-bot-info) To retrieve information about the current Notion bot, use the `getBot` method of the `NotionUser` class. ``` $bot = NotionUser::make()->getBot(); ``` ### Comments [](#comments) #### Retrieving All Comments by Page ID / Discussion ID [](#retrieving-all-comments-by-page-id--discussion-id) To retrieve all comments associated with a page or discussion, use the `index` method of the `NotionComment` class. ``` $comments = NotionComment::make('0b036890391f417cbac775e8b0bba680')->index(); ``` #### Creating a New Comment [](#creating-a-new-comment) To create a new comment on a page or discussion, use the `NotionComment` class and set the parent ID and content. ``` // You can pass a rich text object if you want to format the comment NotionComment::make() ->setDiscussionId('ac803deb7b064cca83067c67914b02b4') ->setContent(NotionRichText::make('This is a comment') ->color('red') ->bold() ->italic() ) ->create(); // Or you can pass a string NotionComment::make() ->setParentId('a270ab4fa945449f9284b180234b00c3') ->setContent('This is a comment') ->create(); ``` ### Pagination [](#pagination) Notion API provides paginated responses for certain endpoints. The `NotionPaginator` class handles pagination for you. #### Example with Search Results [](#example-with-search-results) ``` $response = NotionSearch::inPages('Eyad')->apply(50); $pages = $response->getResults(); // Get the first 50 results $response->hasMore(); // Check if there are more results $response->next() // Get the next 50 results (if hasMore is true) $response->getObjectType(); // Get the type of the object (always "list") $response->getResultsType() // Get the type of the results (Block/Database/Page) ``` ### Mapping Eloquent Models to Notion Database Items [](#mapping-eloquent-models-to-notion-database-items) To map your Laravel Eloquent models to Notion database items, you can use the `Notionable` trait and implement the `mapToNotion` method in your model. ``` class User extends Model { use Notionable; protected string $notionDatabaseId = '74dc9419bec24f10bb2e65c1259fc65a'; protected $guarded = []; public function mapToNotion(): array { return [ 'name' => NotionTitle::make('Name'), 'email' => NotionEmail::make('Email'), 'password' => NotionText::make('Password'), ]; } } $user = User::create([ 'name' => 'John Doe', 'email' => 'johndoe@gmail.com', 'password' => 'password' ]); $user->saveToNotion(); ``` ### Syncing Data between Notion and Eloquent Models [](#syncing-data-between-notion-and-eloquent-models) You can sync data between Notion and Eloquent models using the `sync:to-notion` Artisan command. ``` php artisan sync:to-notion User ``` ### Watching a Notion Database [](#watching-a-notion-database) Currently, Notion API does not support webhooks. However, you can use the 'notion:watch' artisan command to watch a Notion database for changes. The command will run every specified interval and check for changes in the notion database. If there are any changes, it will send a post request to your route, so you can handle it accordingly. You can change the interval and the route in the config file. This is how you can run the command: ``` php artisan notion:watch '02758e48d12244f99552dd4f766a0077' ``` Surely, you can use the command in a cron job to run it every specified interval. ``` // in app/Console/Kernel.php protected function schedule(Schedule $schedule): void { $schedule->command(NotionDatabaseWatcher::class, ['02758e48d12244f99552dd4f766a0077'])->everyMinute(); } ``` ### Handling Errors [](#handling-errors) In case of an error, an exception will be thrown with the error message. You can check the exceptions folder or the `NotionException` class for more information about the exceptions. Please refer to the Notion API documentation for detailed information about the errors. Testing ------- [](#testing) To run the package tests, use the following command: ``` composer test ``` Changelog --------- [](#changelog) Please see the [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [EyadHamza](https://github.com/Eyadhamza) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 30 — LowBetter than 64% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community9 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~26 days Recently: every ~1 days Total 10 Last Release 1025d ago Major Versions v1.2.1 → v2.0.02023-07-09 PHP version history (2 changes)v1.0.0PHP ^8.0 v2.0.0PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/d9cb15eabd6d8e7c3f899d9f176a8cf452db23c406ea7b3cdfcdaf3943ef0ba6?d=identicon)[EyadHamza](/maintainers/EyadHamza) --- Top Contributors [![Eyadhamza](https://avatars.githubusercontent.com/u/65258058?v=4)](https://github.com/Eyadhamza "Eyadhamza (244 commits)") --- Tags laravelnotionnotion-apinotion-api-laravelnotion-api-wrapper-laravelnotion-api-integration-laravelnotion-api-laravel-wrapper ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/pi-space-notion-api-integration/health.svg) ``` [![Health](https://phpackages.com/badges/pi-space-notion-api-integration/health.svg)](https://phpackages.com/packages/pi-space-notion-api-integration) ``` ### Alternatives [fiveam-code/laravel-notion-api Laravel Wrapper for the Notion API 435224.4k1](/packages/fiveam-code-laravel-notion-api)[simplestats-io/laravel-client Client for SimpleStats! 4515.5k](/packages/simplestats-io-laravel-client)[scalar/laravel Render your OpenAPI-based API reference 6183.9k2](/packages/scalar-laravel)[njoguamos/laravel-plausible A laravel package for interacting with plausible analytics api. 208.8k](/packages/njoguamos-laravel-plausible)[ryangjchandler/bearer Minimalistic token-based authentication for Laravel API endpoints. 8129.8k](/packages/ryangjchandler-bearer)[codebar-ag/laravel-docuware DocuWare integration with Laravel 1221.1k](/packages/codebar-ag-laravel-docuware) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)