client

Documentation

Index

• Constants
• type Client
  • func New(token string) *Client
  • func NewWithBaseURL(token, baseURL string) *Client
  • func (c *Client) AddComment(pageID, text string, mentionUserIDs []string) ([]byte, error)
  • func (c *Client) Delete(path string) ([]byte, error)
  • func (c *Client) DeleteComment(commentID string) ([]byte, error)
  • func (c *Client) Get(path string) ([]byte, error)
  • func (c *Client) GetBlock(blockID string) (map[string]interface{}, error)
  • func (c *Client) GetBlockChildren(blockID string, pageSize int, startCursor string) (map[string]interface{}, error)
  • func (c *Client) GetDatabase(dbID string) (map[string]interface{}, error)
  • func (c *Client) GetMe() (map[string]interface{}, error)
  • func (c *Client) GetPage(pageID string) (map[string]interface{}, error)
  • func (c *Client) GetUser(userID string) (map[string]interface{}, error)
  • func (c *Client) GetUsers(pageSize int, startCursor string) (map[string]interface{}, error)
  • func (c *Client) ListComments(blockID string, pageSize int, startCursor string) (map[string]interface{}, error)
  • func (c *Client) Patch(path string, body interface{}) ([]byte, error)
  • func (c *Client) Post(path string, body interface{}) ([]byte, error)
  • func (c *Client) QueryDatabase(dbID string, body map[string]interface{}) (map[string]interface{}, error)
  • func (c *Client) Search(query string, filter string, pageSize int, startCursor string) (map[string]interface{}, error)
  • func (c *Client) SetDebug(debug bool)
  • func (c *Client) UpdateComment(commentID, text string, mentionUserIDs []string) ([]byte, error)
  • func (c *Client) UploadFileContent(uploadID, fileName, contentType string, fileBytes []byte) ([]byte, error)

Constants

const (
	BaseURL        = "https://api.notion.com"
	NotionVersion  = "2022-06-28"
	DefaultTimeout = 30 * time.Second
	UploadTimeout  = 5 * time.Minute
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(token string) *Client

func NewWithBaseURL

func NewWithBaseURL(token, baseURL string) *Client

NewWithBaseURL creates a client pointing at a custom API base (for testing).

func (*Client) AddComment

func (c *Client) AddComment(pageID, text string, mentionUserIDs []string) ([]byte, error)

AddComment adds a comment to a page.

func (*Client) Delete

func (c *Client) Delete(path string) ([]byte, error)

func (*Client) DeleteComment

func (c *Client) DeleteComment(commentID string) ([]byte, error)

DeleteComment removes a comment by id. Wraps DELETE /v1/comments/:id (added in Notion API 2025). When the target is the anchor comment of a discussion, Notion removes the whole thread; otherwise it removes just that one reply.

func (*Client) Get

func (c *Client) Get(path string) ([]byte, error)

func (*Client) GetBlock

func (c *Client) GetBlock(blockID string) (map[string]interface{}, error)

GetBlock retrieves a single block by ID.

func (*Client) GetBlockChildren

func (c *Client) GetBlockChildren(blockID string, pageSize int, startCursor string) (map[string]interface{}, error)

GetBlockChildren retrieves children of a block.

func (*Client) GetDatabase

func (c *Client) GetDatabase(dbID string) (map[string]interface{}, error)

GetDatabase retrieves a database by ID.

func (*Client) GetMe

func (c *Client) GetMe() (map[string]interface{}, error)

GetMe returns the bot user info for the current token.

func (*Client) GetPage

func (c *Client) GetPage(pageID string) (map[string]interface{}, error)

GetPage retrieves a page by ID.

func (*Client) GetUser

func (c *Client) GetUser(userID string) (map[string]interface{}, error)

GetUser retrieves a user by ID.

func (*Client) GetUsers

func (c *Client) GetUsers(pageSize int, startCursor string) (map[string]interface{}, error)

GetUsers lists all users.

func (*Client) ListComments

func (c *Client) ListComments(blockID string, pageSize int, startCursor string) (map[string]interface{}, error)

ListComments lists comments on a block/page.

func (*Client) Patch

func (c *Client) Patch(path string, body interface{}) ([]byte, error)

func (*Client) Post

func (c *Client) Post(path string, body interface{}) ([]byte, error)

func (*Client) QueryDatabase

func (c *Client) QueryDatabase(dbID string, body map[string]interface{}) (map[string]interface{}, error)

QueryDatabase queries a database with filters and sorts.

func (*Client) Search

func (c *Client) Search(query string, filter string, pageSize int, startCursor string) (map[string]interface{}, error)

Search performs a search across the workspace.

func (*Client) SetDebug

func (c *Client) SetDebug(debug bool)

func (*Client) UpdateComment

func (c *Client) UpdateComment(commentID, text string, mentionUserIDs []string) ([]byte, error)

UpdateComment edits the rich_text body of an existing comment. Wraps PATCH /v1/comments/:id (added in Notion API 2025).

func (*Client) UploadFileContent

func (c *Client) UploadFileContent(uploadID, fileName, contentType string, fileBytes []byte) ([]byte, error)

UploadFileContent sends file content to an existing file upload via multipart form.