Home Blog Pricing

Documentation Site & Portal Management API Reference

API Overview Authentication

Health

Check API health GET

Onboarding

Check a Notion page before creating a site GET Check a Notion page (body form) POST Request a new site and send the activation email POST Poll the status of a site request GET Resend the activation email POST

Sites

Get site metadata GET

Members

List and search site members GET Create a new member POST Bulk create up to 500 members POST Get a member with their access groups GET Update a member's details PATCH Permanently delete a member DEL Send or generate a magic login link POST

Access Groups

List all access groups GET Create a custom access group POST Get an access group GET Update a custom access group PATCH Delete a custom access group DEL

Group Members

List members of an access group GET Add a member to an access group POST Remove a member from an access group DEL

Webhooks

List webhook subscriptions GET Create a webhook subscription POST Get a webhook subscription GET Delete a webhook subscription DEL

Types

OnboardingInspection SCHEMA CreateOnboardingRequest SCHEMA OnboardingCreated SCHEMA OnboardingStatus SCHEMA OnboardingResend SCHEMA Site SCHEMA Member SCHEMA MemberWithGroups SCHEMA GroupMember SCHEMA AccessGroup SCHEMA Pagination SCHEMA CreateMemberRequest SCHEMA UpdateMemberRequest SCHEMA BulkCreateMembersRequest SCHEMA BulkResultItem SCHEMA BulkSummary SCHEMA CreateAccessGroupRequest SCHEMA UpdateAccessGroupRequest SCHEMA AddGroupMemberRequest SCHEMA WebhookEvent SCHEMA Webhook SCHEMA WebhookWithSecret SCHEMA CreateWebhookRequest SCHEMA ApiError SCHEMA

Webhooks Overview Event Payloads Verifying signatures Retry behavior Best practices

All Collections

Webhooks

Automate workflows and connect Sotion with other apps using webhooks.

Webhooks Overview

Event Payloads

Verifying signatures

Retry behavior

Best practices