Open main menu
HomeBlogPricingDocs
Get started

Sotion Members API

Explore Sotion’s Members API and unlock new dimensions in managing your Notion Pages memberships. Detailed guides to integrate with any platform.

Membership Management
•Published on
Table of Contents
Sotion Members API
Slug
members-api
Excerpt
Explore Sotion’s Members API and unlock new dimensions in managing your Notion Pages memberships. Detailed guides to integrate with any platform.

How to enable Sotion Membership Management API

To enable the API, update your page Membership Option to one of these three options:
  • Email Sign Up
  • Restricted Email List
  • Paid Membership (Stripe, Lemon Squeezy, or Gumroad)
notion image
notion image
 

Sotion Membership Management API Documentation

Authentication

Your API Key will be generated as part of your API URL.
For each request you also have to specify the SITE ID, this will be automatically populated on your dashboard.
Format:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}
Example:
https://d600c2d2-e07e-46b9-b79a-f0376aaa303d.api.sotion.app/E1CP6DYM2JF6H

LIST ALL MEMBERS

List all the members of your site.
Method: GET
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members
Response:
{
    "siteId": "E1CP6DYM2JF6H",
    "status": "active",
    "domain": "sub.domain.com",
    "pageUrl": "https://sub.domain.com/5d134986fc72480188g18d116118478f",
    "authType": "email",
    "config": {
        "members": [
            {
                "email": "name@email.com",
                "uuid": "5699fa63-f01a-4964-b0ef-3cf8bc61fa04",
                "registeredAt": "2022-07-01T14:35:57.347Z",
                "verified": true,
                "blocked": false,
                "paid": true
            }
        ]
    }
}
 

SEARCH MEMBERS

Search for members based on email, verified status, or paid status.
Method: GET
Parameters (any combination):
  • email=name@email.com
  • verified=true|false
  • paid=true|false
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members?email=name@email.com&verified=true&paid=true
Response:
{
    "siteId": "E1CP6DYM2JF6H",
    "status": "active",
    "domain": "sub.domain.com",
    "pageUrl": "https://sub.domain.com/5d134986fc72480188g18d116118478f",
    "authType": "email",
    "config": {
        "members": [
            {
                "email": "name@email.com",
                "uuid": "5699fa63-f01a-4964-b0ef-3cf8bc61fa04",
                "registeredAt": "2022-07-01T14:35:57.347Z",
                "verified": true,
                "blocked": false,
                "paid": true
            }
        ]
    }
}
 

GET MEMBER

Fetch a specific member based on their id.
Method: GET
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members/{MEMBER_UUID}
Response:
{
    "siteId": "E1CP6DYM2JF6H",
    "status": "active",
    "domain": "sub.domain.com",
    "pageUrl": "https://sub.domain.com/5d134986fc72480188g18d116118478f",
    "authType": "email",
    "config": {
        "members": [
            {
                "email": "name@email.com",
                "uuid": "5699fa63-f01a-4964-b0ef-3cf8bc61fa04",
                "registeredAt": "2022-07-01T14:35:57.347Z",
                "verified": true,
                "blocked": false,
                "paid": true
            }
        ]
    }
}
 

CREATE MEMBER

Create a new Member and add them to your site.
Method: POST
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members
Request Body:
{
    "email": "name@email.com",
    "paid": false
}
Response:
{
    "siteId": "E1CP6DYM2JF6H",
    "status": "active",
    "domain": "sub.domain.com",
    "pageUrl": "https://sub.domain.com/5d134986fc72480188g18d116118478f",
    "authType": "email",
    "config": {
        "members": [
            {
                "email": "name@email.com",
                "uuid": "5699fa63-f01a-4964-b0ef-3cf8bc61fa04",
                "registeredAt": "2022-07-01T14:35:57.347Z",
                "verified": false,
                "blocked": false,
                "paid": false
            }
        ]
    }
}
 

UPDATE MEMBER

Update the details of an existing member.
Method: PATCH
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members/{MEMBER_UUID}
Request Body:
{
    "email": "name@email.com",
    "paid": true
}
Response:
{
    "siteId": "E1CP6DYM2JF6H",
    "status": "active",
    "domain": "sub.domain.com",
    "pageUrl": "https://sub.domain.com/5d134986fc72480188g18d116118478f",
    "authType": "email",
    "config": {
        "members": [
            {
                "email": "name@email.com",
                "uuid": "5699fa63-f01a-4964-b0ef-3cf8bc61fa04",
                "registeredAt": "2022-07-01T14:35:57.347Z",
                "verified": false,
                "blocked": false,
                "paid": true
            }
        ]
    }
}
 

DELETE MEMBER

Delete an existing member based on their id.
Method: DELETE
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members/{MEMBER_UUID}
Response:
{
    "siteId": "E2SZFRG1WMJOU0",
    "memberId": "9bcf796e-3e99-4c86-bf31-a46163effa4b",
    "status": "Deleted"
}
 

MEMBER LOGIN LINK

Manually generate a Login Link for a member.
Method: GET
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members/{MEMBER_UUID}/login-link
Response:
{
    "loginLink": "https://sub.domain.com/_auth?uuid=e36da7cf-71db-456a-8f91-eb3a3dbe3949&email=name%40email.com&magic=verify"
}
 

SEND MEMBER LOGIN LINK

Manually generate and Send a Login Link to a member.
Method: GET
Request:
https://{API_KEY}.api.sotion.app/sites/{SITE_ID}/members/{MEMBER_UUID}/login-link/send
Response:
{
    "siteId": "E1CP6DYM2JF6H",
    "status": "active",
    "domain": "sub.domain.com",
    "pageUrl": "https://sub.domain.com/5d134986fc72480188g18d116118478f",
    "authType": "email",
    "config": {
        "members": [
            {
                "email": "name@email.com",
                "uuid": "5699fa63-f01a-4964-b0ef-3cf8bc61fa04",
                "registeredAt": "2022-07-01T14:35:57.347Z",
                "verified": true,
                "blocked": false,
                "paid": true
            }
        ]
    }
}
 

Data Types

ㅤ
Key
Possible Values
Details
Site
status
active | deleted
Indicates the status of your site. Most of the time this will be active. If you delete your site then you can still retrieve the members.
Site
authType
email | whitelist | gumroad
Indicates the Membership Type for your site. - email: Email Sign Up - whitelist: Restricted Email List - gumroad: Paid Membership
Member
verified
true | false
Indicates if a member has successfully verified their email address using the magic link.
Member
blocked
true | false
Not used at the moment. Will be a new feature in future.
Member
paid
true | false
Indicates if this is a paid member.

Response Status Codes

HTTP Status Code
Message
Details
200
Success
All good
400
Bad Request: Invalid siteId
Invalid SITE_ID
400
Bad Request: Member email required
Missing email address when creating new member
400
Bad Request: Member already exists
Cannot create member with the same email
401
Unauthorized
Invalid API_KEY
404
Member not found
No Member found for MEMBER_UUID during GET, PATCH, DELETE
405
Method Not Allowed
Invalid HTTP Method. Only GET, POST, PATCH, DELETE are allowed
500
Server Error
Something went wrong on our side
 

Webhooks

( 👀 coming soon… )

7-day free trial. No credit card needed

Take control of your Notion site today!

Get started →

Written by

Bruce McLachlan
Bruce McLachlan

Meet Bruce, the founder behind Sotion, and explore his vision on enhancing Notion Pages. Get a glimpse of the journey and the future roadmap of Sotion.

Related posts

Restricted Email List with Sotion for Notion Members-only Access
Email Sign UpMembership ManagementCustom Domain
•

Restricted Email List with Sotion for Notion Members-only Access

Use Sotion's Restricted Email List feature for controlled Notion site access and content protection. Easily manage membership and maintain exclusivity.

Use Email Signup with Sotion for Notion Member Registration
Email Sign UpMembership Management
•

Use Email Signup with Sotion for Notion Member Registration

Discover Sotion's Email Signup for easy membership registration and seamless login for your Notion site. Build a community and control content access.

Make a Paid Membership site with Notion and Gumroad
Membership ManagementMarketing
•

Make a Paid Membership site with Notion and Gumroad

Offer exclusive content like courses or ebooks with paid access on Notion, managed by Gumroad. Notion organizes while Gumroad handles payments.

Securely Share Notion Template

Securely Share Notion Template

Discover Sotion’s innovative method of sharing Notion Templates. Enjoy secure template sharing on your domain and manage your membership site.

Automate Notion Memberships with Zapier and Sotion Members API
NotionMembership Management
•

Automate Notion Memberships with Zapier and Sotion Members API

Discover how to integrate and automate memberships on your Notion website using Zapier and the Sotion Members API.

Stripe Paid Memberships for Notion
SotionNotionMembership Management
•

Stripe Paid Memberships for Notion

Set up Stripe paid memberships for your Notion site with Sotion. Step-by-step guide for seamless integration.

How to Create a Paid Membership Site with Notion
Membership ManagementCustom BrandingEmail Sign Up
•

How to Create a Paid Membership Site with Notion

Create a paid membership site with Notion using Sotion. Integrate Stripe, Lemon Squeezy, or Gumroad easily.

Sotion Membership Management Webhooks

Sotion Membership Management Webhooks

Automatically receive updates on members being added and removed from your Sotion website. Integrate seamlessly to any other tool in your business.

Top Tools for Automating Member Onboarding in Notion
NotionSotionMembership Management
•

Top Tools for Automating Member Onboarding in Notion

Streamline member onboarding in Notion with top automation tools, enhancing efficiency and reducing errors for seamless workflows.