API Reference

List view

Getting started
Overview
Creating your first Notion website
Using a Bullet template
Managing content in Notion
Understanding notion structure
Managing images
Auto sync and Publish
Custom 404 page
Understanding Bullet dashboard
Navbar/Header customization
Footer customization
Logo, favicon and social share image
Custom code
Add search functionality
Sidebar
Hosting
Adding custom domain
Hosting in Root or Apex domain
Sub-directory hosting
Managing Page Redirects
Making both APEX and WWW to work
Restrict Your Site to Custom Domain Only
Membership/Content Gating
Overview
Password Protection
Email Confirmation access
Segment-Specific Restriction
Blog
How to setup your blog with Bullet
Understanding Bullet blog structure in Notion
Posts database properties
Authors database properties
Tags database properties
Blog Settings
Knowledge base
How to use the knowledge base plugin?
Category, sub-category and articles
Knowledge Base widget
SEO and metadata
SEO in Bullet
Sitemap and RSS Feeds
Liquid Syntax
What is Liquid syntax?
How does merge tags work?
Hiding blocks in Bullet
Conditionally rendering blocks
Embed HTML inside Notion
API Documentation
Overview
API Authentication
API Reference
Billing
Billing FAQs
How to's
How to unpublish an existing page
Add Buttons inside Notion website
Show database views as Tabs
Prevent discovery of Notion Page
How to use different templates in the same website
How to embed forms in Notion and Bullet?
Embedding content in Notion and Bullet
Troubleshooting
Missing pages in Bullet, Links pointing to #
Notion table instead of webpage
Themes
Theme settings

API Reference

Before getting started

Almost all of the APIs listed here need the following details.
  • Site ID
  • API Key
 
API Root url
https://api.bullet.so/api/v1

Get a list of all members for a specific site

GET /sites/:site_id/members/

Add a member to a site

Note: Adding new segments is not possible via API. You need to add new segments from Dashboard. You can only pass existing segments from API.
POST /sites/:site_id/members/

{
	"name": "John Doe",
  "email":"john.doe@gmail.com",
  "allowedSegments":["free","vip"] 
}

Update a member's information

PATCH /sites/:site_id/members/:email

{
	"name": "John Doe",
  "allowedSegments":["free","vip"] 
}

Add a member to a specific segment

Note: Adding new segments is not possible via API. You need to add new segments from Dashboard. You can only pass existing segments from API.
POST /sites/:site_id/members/:email/segments

{
  "allowedSegments":["premium"] 
}
 

Remove segment from a member

DELETE /sites/:site_id/members/:email/segments
{
   "allowedSegments":["premium"] 
}
 

Remove a member from a site

 
DELETE /sites/:site_id/members/:email