README

Effortless Notion integrations with Laravel

This package provides a simple and crisp way to access the Notion API endpoints, query data and update existing entries.

Installation

You can install the package via composer:

composer require fiveam-code/laravel-notion-api

Authorization

The Notion API requires an access token and a Notion integration, the Notion documentation explains how this works. It's important to grant access to the integration within your Notion account to enable the API access.

Add your Notion API token to your .env file:

NOTION_API_TOKEN="$YOUR_ACCESS_TOKEN"

Usage

Head over to the Documentation of this package.

🔥 Code Examples to jumpstart your Notion API Project

Basic Setup (+ example)

use FiveamCode\LaravelNotionApi\Notion; 

# Access through Facade (token has to be set in .env)
\Notion::databases()->find($databaseId);

# Custom instantiation (necessary if you want to access more than one NotionApi integration)
$notion = new Notion($apiToken, $apiVersion); // version-default is 'v1'
$notion->databases()->find($databaseId);

Fetch Page Information

// Returns a specific page
\Notion::pages()->find($yourPageId);

Search

// Returns a collection pages and databases of your workspace (included in your integration-token)
\Notion::search($searchText)
        ->query()
        ->asCollection();

Query Database

// Queries a specific database and returns a collection of pages (= database entries)
$sortings = new Collection();
$filters = new Collection();

$sortings
  ->add(Sorting::propertySort('Ordered', 'ascending'));
$sortings
  ->add(Sorting::timestampSort('created_time', 'ascending'));

$filters
  ->add(Filter::textFilter('title', ['contains' => 'new']));
// or
$filters
  ->add(Filter::rawFilter('Tags', ['multi_select' => ['contains' => 'great']]));
  
\Notion::database($yourDatabaseId)
      ->filterBy($filters) // filters are optional
      ->sortBy($sortings) // sorts are optional
      ->limit(5) // limit is optional
      ->query()
      ->asCollection();

Testing

vendor/bin/phpunit tests

Support

If you use this package in one of your projects or just want to support our development, consider becoming a Patreon!

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email hello@dianaweb.dev instead of using the issue tracker.

Used By

Julien Nahum created notionforms.io with laravel-notion-api, which allows you to easily create custom forms, based on your selected database within notion.
GitHub Notion Sync, a service by Beyond Code to sync the issues of multiple GitHub repositories into a Notion database
Notion Invoice, the first premium invoicing solution for freelancers and businesses that use Notion. Create beautiful PDF invoices from your Notion data.

Using this package in your project? Open a PR to add it in this section!

Credits

License

The MIT License (MIT). Please see License File for more information.

saas-estate / laravel-notion-api

Maintainers

Details