Home Blog Pricing

Documentation Site & Portal Management API Reference

API Overview Authentication

Health

Check API health GET

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

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

ApiError

Schema

Fields

· 1

error object required

Used by

· 20 operations

GET Get site metadata GET List and search site members POST Create a new member POST Bulk create up to 500 members GET Get a member with their access groups PATCH Update a member's details DEL Permanently delete a member POST Send or generate a magic login link GET List all access groups POST Create a custom access group GET Get an access group PATCH Update a custom access group DEL Delete a custom access group GET List members of an access group POST Add a member to an access group DEL Remove a member from an access group GET List webhook subscriptions POST Create a webhook subscription GET Get a webhook subscription DEL Delete a webhook subscription