Sotion
HomeBlogPricing
Documentation Site & Portal Management API Reference
API
API Overview Authentication
Health
Check API health GET
Onboarding
Check a Notion page before creating a site GETCheck a Notion page (body form) POSTRequest a new site and send the activation email POSTPoll the status of a site request GETResend the activation email POST
Sites
Get site metadata GET
Members
List and search site members GETCreate a new member POSTBulk create up to 500 members POSTGet a member with their access groups GETUpdate a member's details PATCHPermanently delete a member DELSend or generate a magic login link POST
Access Groups
List all access groups GETCreate a custom access group POSTGet an access group GETUpdate a custom access group PATCHDelete a custom access group DEL
Group Members
List members of an access group GETAdd a member to an access group POSTRemove a member from an access group DEL
Webhooks
List webhook subscriptions GETCreate a webhook subscription POSTGet a webhook subscription GETDelete a webhook subscription DEL
Types
OnboardingInspection SCHEMACreateOnboardingRequest SCHEMAOnboardingCreated SCHEMAOnboardingStatus SCHEMAOnboardingResend SCHEMASite SCHEMAMember SCHEMAMemberWithGroups SCHEMAGroupMember SCHEMAAccessGroup SCHEMAPagination SCHEMACreateMemberRequest SCHEMAUpdateMemberRequest SCHEMABulkCreateMembersRequest SCHEMABulkResultItem SCHEMABulkSummary SCHEMACreateAccessGroupRequest SCHEMAUpdateAccessGroupRequest SCHEMAAddGroupMemberRequest SCHEMAWebhookEvent SCHEMAWebhook SCHEMAWebhookWithSecret SCHEMACreateWebhookRequest SCHEMAApiError SCHEMA
Webhooks
Webhooks Overview Event Payloads Verifying signatures Retry behavior Best practices
REST API

ApiError

Schema

Fields

· 1
error object required

Used by

· 25 operations
GET Check a Notion page before creating a sitePOST Check a Notion page (body form)POST Request a new site and send the activation emailGET Poll the status of a site requestPOST Resend the activation emailGET Get site metadataGET List and search site membersPOST Create a new memberPOST Bulk create up to 500 membersGET Get a member with their access groupsPATCH Update a member's detailsDEL Permanently delete a memberPOST Send or generate a magic login linkGET List all access groupsPOST Create a custom access groupGET Get an access groupPATCH Update a custom access groupDEL Delete a custom access groupGET List members of an access groupPOST Add a member to an access groupDEL Remove a member from an access groupGET List webhook subscriptionsPOST Create a webhook subscriptionGET Get a webhook subscriptionDEL Delete a webhook subscription