mirror of https://github.com/dstotijn/go-notion.git synced 2024-11-24 08:42:26 +02:00

Go client for the Notion API.

Go to file

David Stotijn 5e7e8ed54c Add "create database" endpoint		2021-07-20 22:50:53 +02:00
block.go	Add tests for "append block children" endpoint	2021-05-22 23:37:52 +02:00
client_test.go	Add "create database" endpoint	2021-07-20 22:50:53 +02:00
client.go	Add "create database" endpoint	2021-07-20 22:50:53 +02:00
database.go	Add "create database" endpoint	2021-07-20 22:50:53 +02:00
error.go	Simplify APIError.Unwrap, fix missing error message prefixes	2021-05-14 18:24:56 +02:00
go.mod	Add tests for `NewClient` and `Client.FindDatabaseByID`	2021-05-17 21:08:13 +02:00
go.sum	Add tests for `NewClient` and `Client.FindDatabaseByID`	2021-05-17 21:08:13 +02:00
LICENSE	Initial commit	2021-05-13 22:11:32 +02:00
page.go	Add `URL` field to `Page` type	2021-07-20 20:57:27 +02:00
parent.go	Add `Parent` field to `Database` type	2021-07-20 20:48:35 +02:00
README.md	Add "create database" endpoint	2021-07-20 22:50:53 +02:00
rich_text.go	Add custom type for Notion date properties with optional time	2021-05-23 14:02:17 +02:00
search.go	Fix faulty search sort type, add consts for sort props	2021-05-27 20:50:04 +02:00
time_test.go	Add custom type for Notion date properties with optional time	2021-05-23 14:02:17 +02:00
time.go	Add custom type for Notion date properties with optional time	2021-05-23 14:02:17 +02:00
user.go	Add "list users" endpoint support	2021-05-15 20:50:47 +02:00
util.go	Fix incorrect types for `Formula`, `Relation` and `Rollup` page props	2021-05-24 16:33:03 +02:00

go-notion

go-notion is a client for the Notion API, written in Go.

Features

The client supports all (non-deprecated) endpoints available in the Notion API, as of July 20, 2021:

$ go get github.com/dstotijn/go-notion

To obtain an API key, follow Notion’s getting started guide.

First, construct a new Client:

import "github.com/dstotijn/go-notion"

(...)

client := notion.NewClient("secret-api-key")

Then, use the methods defined on Client to make requests to the API. For example:

page, err := client.FindPageByID(context.Background(), "18d35eb5-91f1-4dcb-85b0-c340fd965015")
if err != nil {
    // Handle error...
}

👉 Check out the docs on pkg.go.dev for further reference and examples.

The Notion API is currently in public beta.

⚠️ Although the API itself is versioned, this client will make breaking changes in its code until v1.0 of the module is released.