# SnackBase ## Docs - [Create Account](https://docs.snackbase.dev/api-reference/endpoints/accounts/create-account.md): Create a new account. - [Delete Account](https://docs.snackbase.dev/api-reference/endpoints/accounts/delete-account.md): Delete an account. - [Get Account](https://docs.snackbase.dev/api-reference/endpoints/accounts/get-account.md): Get detailed account information. - [Get Account Users](https://docs.snackbase.dev/api-reference/endpoints/accounts/get-account-users.md): Get users in an account. - [List Accounts](https://docs.snackbase.dev/api-reference/endpoints/accounts/list-accounts.md): List all accounts with pagination, sorting, and search. - [Update Account](https://docs.snackbase.dev/api-reference/endpoints/accounts/update-account.md): Update an account. - [Create Configuration](https://docs.snackbase.dev/api-reference/endpoints/admin/create-configuration.md): Create a new configuration record. - [Delete Configuration](https://docs.snackbase.dev/api-reference/endpoints/admin/delete-configuration.md): Delete a configuration. - [Get Account Configurations](https://docs.snackbase.dev/api-reference/endpoints/admin/get-account-configurations.md): List all configurations for a specific account. - [Get Available Providers](https://docs.snackbase.dev/api-reference/endpoints/admin/get-available-providers.md): List all available provider definitions. - [Get Configuration Stats](https://docs.snackbase.dev/api-reference/endpoints/admin/get-configuration-stats.md): Get configuration statistics for the dashboard. - [Get Configuration Values](https://docs.snackbase.dev/api-reference/endpoints/admin/get-configuration-values.md): Get decrypted configuration values with secrets masked. - [Get Email Log](https://docs.snackbase.dev/api-reference/endpoints/admin/get-email-log.md): Get email log by ID. - [Get Email Template](https://docs.snackbase.dev/api-reference/endpoints/admin/get-email-template.md): Get email template by ID. - [Get Provider Schema](https://docs.snackbase.dev/api-reference/endpoints/admin/get-provider-schema.md): Get the JSON schema for a specific provider. - [Get Recent Configurations](https://docs.snackbase.dev/api-reference/endpoints/admin/get-recent-configurations.md): Get recently modified configurations. - [Get System Configurations](https://docs.snackbase.dev/api-reference/endpoints/admin/get-system-configurations.md): List all system configurations. - [List Email Logs](https://docs.snackbase.dev/api-reference/endpoints/admin/list-email-logs.md): List email logs with optional filters and pagination. - [List Email Templates](https://docs.snackbase.dev/api-reference/endpoints/admin/list-email-templates.md): List all email templates with optional filters. - [Render Email Template](https://docs.snackbase.dev/api-reference/endpoints/admin/render-email-template.md): Render an email template without sending. - [Send Test Email](https://docs.snackbase.dev/api-reference/endpoints/admin/send-test-email.md): Send a test email using the specified template. - [Test Provider Connection](https://docs.snackbase.dev/api-reference/endpoints/admin/test-provider-connection.md): Test connection for a provider configuration. - [Update Configuration Status](https://docs.snackbase.dev/api-reference/endpoints/admin/update-configuration-status.md): Update configuration status (enable/disable). - [Update Configuration Values](https://docs.snackbase.dev/api-reference/endpoints/admin/update-configuration-values.md): Update configuration values. - [Update Email Template](https://docs.snackbase.dev/api-reference/endpoints/admin/update-email-template.md): Update an email template. - [Export Audit Logs](https://docs.snackbase.dev/api-reference/endpoints/audit-logs/export-audit-logs.md): Export audit logs in CSV or JSON format. - [Get Audit Log](https://docs.snackbase.dev/api-reference/endpoints/audit-logs/get-audit-log.md): Get a single audit log entry by ID. - [List Audit Logs](https://docs.snackbase.dev/api-reference/endpoints/audit-logs/list-audit-logs.md): List audit log entries with advanced filtering and pagination. - [Acs](https://docs.snackbase.dev/api-reference/endpoints/auth/acs.md): SAML Assertion Consumer Service (ACS) endpoint. - [Authorize](https://docs.snackbase.dev/api-reference/endpoints/auth/authorize.md): Initiate OAuth authorization flow. - [Callback](https://docs.snackbase.dev/api-reference/endpoints/auth/callback.md): Complete OAuth authorization flow. - [Forgot Password](https://docs.snackbase.dev/api-reference/endpoints/auth/forgot-password.md): Initiate password reset flow. - [Get Current User Info](https://docs.snackbase.dev/api-reference/endpoints/auth/get-current-user-info.md): Get the current authenticated user's information. - [Login](https://docs.snackbase.dev/api-reference/endpoints/auth/login.md): Authenticate a user and return JWT tokens. - [Metadata](https://docs.snackbase.dev/api-reference/endpoints/auth/metadata.md): Download SAML Service Provider Metadata XML. - [Refresh Tokens](https://docs.snackbase.dev/api-reference/endpoints/auth/refresh-tokens.md): Refresh access and refresh tokens. - [Register](https://docs.snackbase.dev/api-reference/endpoints/auth/register.md): Register a new account and user. - [Resend Verification](https://docs.snackbase.dev/api-reference/endpoints/auth/resend-verification.md): Resend verification email to the user. - [Reset Password](https://docs.snackbase.dev/api-reference/endpoints/auth/reset-password.md): Reset password using a valid reset token. - [Send Verification Email](https://docs.snackbase.dev/api-reference/endpoints/auth/send-verification-email.md): Send a verification email to the current user. - [Sso](https://docs.snackbase.dev/api-reference/endpoints/auth/sso.md): Initiate SAML Single Sign-On flow. - [Verify Email](https://docs.snackbase.dev/api-reference/endpoints/auth/verify-email.md): Verify a user's email address using a token. - [Verify Reset Token](https://docs.snackbase.dev/api-reference/endpoints/auth/verify-reset-token.md): Verify if a password reset token is valid without using it. - [Create Collection](https://docs.snackbase.dev/api-reference/endpoints/collections/create-collection.md): Create a new collection with custom schema. - [Delete Collection](https://docs.snackbase.dev/api-reference/endpoints/collections/delete-collection.md): Delete collection and drop its physical table. - [Get Collection](https://docs.snackbase.dev/api-reference/endpoints/collections/get-collection.md): Get collection details by ID. - [Get Collection Names](https://docs.snackbase.dev/api-reference/endpoints/collections/get-collection-names.md): Get simple list of all collection names. - [Get collection rules](https://docs.snackbase.dev/api-reference/endpoints/collections/get-collection-rules.md) - [List Collections](https://docs.snackbase.dev/api-reference/endpoints/collections/list-collections.md): List all collections with pagination and search. - [Update Collection](https://docs.snackbase.dev/api-reference/endpoints/collections/update-collection.md): Update collection schema. - [Update collection rules](https://docs.snackbase.dev/api-reference/endpoints/collections/update-collection-rules.md) - [Create Endpoint](https://docs.snackbase.dev/api-reference/endpoints/custom-endpoints/create-endpoint.md): Create a new custom endpoint for the current account. - [Delete Endpoint](https://docs.snackbase.dev/api-reference/endpoints/custom-endpoints/delete-endpoint.md): Delete a custom endpoint. - [Get Endpoint](https://docs.snackbase.dev/api-reference/endpoints/custom-endpoints/get-endpoint.md): Retrieve a single custom endpoint by ID. - [List Endpoint Executions](https://docs.snackbase.dev/api-reference/endpoints/custom-endpoints/list-endpoint-executions.md): List execution history for a custom endpoint, newest first. - [List Endpoints](https://docs.snackbase.dev/api-reference/endpoints/custom-endpoints/list-endpoints.md): List custom endpoints for the current account. - [Toggle Endpoint](https://docs.snackbase.dev/api-reference/endpoints/custom-endpoints/toggle-endpoint.md): Toggle a custom endpoint's enabled/disabled state. - [Update Endpoint](https://docs.snackbase.dev/api-reference/endpoints/custom-endpoints/update-endpoint.md): Update a custom endpoint. - [Get Dashboard Stats](https://docs.snackbase.dev/api-reference/endpoints/dashboard/get-dashboard-stats.md): Get dashboard statistics. - [Download a file](https://docs.snackbase.dev/api-reference/endpoints/files/download-a-file.md): Download a file from storage. Requires authentication and proper permissions. - [Upload a file](https://docs.snackbase.dev/api-reference/endpoints/files/upload-a-file.md): Upload a file to storage. Returns file metadata including path for use in records. - [Add user to group](https://docs.snackbase.dev/api-reference/endpoints/groups/add-user-to-group.md): Add a user to a group. - [Create a new group](https://docs.snackbase.dev/api-reference/endpoints/groups/create-a-new-group.md): Create a new group in the user's account. - [Delete a group](https://docs.snackbase.dev/api-reference/endpoints/groups/delete-a-group.md): Delete a group. - [Get a group](https://docs.snackbase.dev/api-reference/endpoints/groups/get-a-group.md): Get a specific group by ID. - [List groups](https://docs.snackbase.dev/api-reference/endpoints/groups/list-groups.md): List all groups in the user's account (or all groups if superadmin). - [Remove user from group](https://docs.snackbase.dev/api-reference/endpoints/groups/remove-user-from-group.md): Remove a user from a group. - [Update a group](https://docs.snackbase.dev/api-reference/endpoints/groups/update-a-group.md): Update a group. - [Health Check](https://docs.snackbase.dev/api-reference/endpoints/health/health-check.md): Basic health check endpoint. - [Liveness Check](https://docs.snackbase.dev/api-reference/endpoints/health/liveness-check.md): Liveness check endpoint. - [Readiness Check](https://docs.snackbase.dev/api-reference/endpoints/health/readiness-check.md): Readiness check endpoint. - [Create Hook](https://docs.snackbase.dev/api-reference/endpoints/hooks/create-hook.md): Create a new hook for the current account. - [Delete Hook](https://docs.snackbase.dev/api-reference/endpoints/hooks/delete-hook.md): Delete a hook. - [Get Hook](https://docs.snackbase.dev/api-reference/endpoints/hooks/get-hook.md): Retrieve a single hook by ID. - [List Hook Executions](https://docs.snackbase.dev/api-reference/endpoints/hooks/list-hook-executions.md): List execution history for a hook, newest first. - [List Hooks](https://docs.snackbase.dev/api-reference/endpoints/hooks/list-hooks.md): List hooks for the current account with optional filters. - [Toggle Hook](https://docs.snackbase.dev/api-reference/endpoints/hooks/toggle-hook.md): Toggle a hook's enabled/disabled state. - [Trigger Hook](https://docs.snackbase.dev/api-reference/endpoints/hooks/trigger-hook.md): Manually trigger a hook. - [Update Hook](https://docs.snackbase.dev/api-reference/endpoints/hooks/update-hook.md): Update a hook. - [Accept Invitation](https://docs.snackbase.dev/api-reference/endpoints/invitations/accept-invitation.md): Accept an invitation and create a user account. - [Cancel Invitation](https://docs.snackbase.dev/api-reference/endpoints/invitations/cancel-invitation.md): Cancel an invitation. - [Create Invitation](https://docs.snackbase.dev/api-reference/endpoints/invitations/create-invitation.md): Create a new invitation. - [Get Invitation](https://docs.snackbase.dev/api-reference/endpoints/invitations/get-invitation.md): Get public invitation details. - [List Invitations](https://docs.snackbase.dev/api-reference/endpoints/invitations/list-invitations.md): List invitations. - [Resend Invitation](https://docs.snackbase.dev/api-reference/endpoints/invitations/resend-invitation.md): Resend an invitation email. - [Cancel Job](https://docs.snackbase.dev/api-reference/endpoints/jobs/cancel-job.md): Cancel and delete a pending job. - [Get Job Statistics](https://docs.snackbase.dev/api-reference/endpoints/jobs/get-job-stats.md): Get aggregate job counts by status. - [List Jobs](https://docs.snackbase.dev/api-reference/endpoints/jobs/list-jobs.md): List background jobs with optional filters and pagination. - [Retry Job](https://docs.snackbase.dev/api-reference/endpoints/jobs/retry-job.md): Manually retry a dead, failed, or retrying job. - [Create Macro](https://docs.snackbase.dev/api-reference/endpoints/macros/create-macro.md): Create a new SQL macro. - [Delete Macro](https://docs.snackbase.dev/api-reference/endpoints/macros/delete-macro.md): Delete a SQL macro. - [Get Macro](https://docs.snackbase.dev/api-reference/endpoints/macros/get-macro.md): Get a SQL macro by ID. - [List Macros](https://docs.snackbase.dev/api-reference/endpoints/macros/list-macros.md): List all SQL macros. - [Test Macro](https://docs.snackbase.dev/api-reference/endpoints/macros/test-macro.md): Test a SQL macro execution. - [Update Macro](https://docs.snackbase.dev/api-reference/endpoints/macros/update-macro.md): Update a SQL macro. - [Get Current Migration](https://docs.snackbase.dev/api-reference/endpoints/migrations/get-current-migration.md): Get current database revision. - [Get Migration History](https://docs.snackbase.dev/api-reference/endpoints/migrations/get-migration-history.md): Get full migration history. - [List Migrations](https://docs.snackbase.dev/api-reference/endpoints/migrations/list-migrations.md): List all Alembic revisions. - [Sse Endpoint](https://docs.snackbase.dev/api-reference/endpoints/realtime/sse-endpoint.md): SSE endpoint for real-time subscriptions. - [Websocket endpoint](https://docs.snackbase.dev/api-reference/endpoints/realtime/websocket-endpoint.md) - [Create Record](https://docs.snackbase.dev/api-reference/endpoints/records/create-record.md): Create a new record in a collection. - [Delete Record](https://docs.snackbase.dev/api-reference/endpoints/records/delete-record.md): Delete a record by ID. - [Get Record](https://docs.snackbase.dev/api-reference/endpoints/records/get-record.md): Get a single record by ID. - [List Records](https://docs.snackbase.dev/api-reference/endpoints/records/list-records.md): List records in a collection. - [Update Record Full](https://docs.snackbase.dev/api-reference/endpoints/records/update-record-full.md): Update a record (full replacement). - [Update Record Partial](https://docs.snackbase.dev/api-reference/endpoints/records/update-record-partial.md): Update a record (partial update). - [Bulk update permissions](https://docs.snackbase.dev/api-reference/endpoints/roles/bulk-update-permissions.md) - [Create Role](https://docs.snackbase.dev/api-reference/endpoints/roles/create-role.md): Create a new role. - [Delete Role](https://docs.snackbase.dev/api-reference/endpoints/roles/delete-role.md): Delete a role. - [Get permissions matrix](https://docs.snackbase.dev/api-reference/endpoints/roles/get-permissions-matrix.md) - [Get Role](https://docs.snackbase.dev/api-reference/endpoints/roles/get-role.md): Get a role by ID. - [Get role permissions](https://docs.snackbase.dev/api-reference/endpoints/roles/get-role-permissions.md) - [List Roles](https://docs.snackbase.dev/api-reference/endpoints/roles/list-roles.md): List all roles. - [Test rule](https://docs.snackbase.dev/api-reference/endpoints/roles/test-rule.md) - [Update Role](https://docs.snackbase.dev/api-reference/endpoints/roles/update-role.md): Update a role. - [Validate rule](https://docs.snackbase.dev/api-reference/endpoints/roles/validate-rule.md) - [Create a new user](https://docs.snackbase.dev/api-reference/endpoints/users/create-a-new-user.md): Create a new user in any account (superadmin only). - [Deactivate a user](https://docs.snackbase.dev/api-reference/endpoints/users/deactivate-a-user.md): Deactivate a user (soft delete via is_active flag) (superadmin only). - [Get a user](https://docs.snackbase.dev/api-reference/endpoints/users/get-a-user.md): Get a specific user by ID (superadmin only). - [List users](https://docs.snackbase.dev/api-reference/endpoints/users/list-users.md): List users with optional filters (superadmin only). - [Manually verify user email](https://docs.snackbase.dev/api-reference/endpoints/users/manually-verify-user-email.md): Manually mark a user's email as verified (superadmin only). - [Resend verification email](https://docs.snackbase.dev/api-reference/endpoints/users/resend-verification-email.md): Resend verification email to a user (superadmin only). - [Reset user password](https://docs.snackbase.dev/api-reference/endpoints/users/reset-user-password.md): Reset a user's password (superadmin only). - [Update a user](https://docs.snackbase.dev/api-reference/endpoints/users/update-a-user.md): Update a user's email, role, or active status (superadmin only). - [Create Webhook](https://docs.snackbase.dev/api-reference/endpoints/webhooks/create-webhook.md): Create a new outbound webhook for the current account. - [Delete Webhook](https://docs.snackbase.dev/api-reference/endpoints/webhooks/delete-webhook.md): Delete a webhook and all its delivery history. - [Get Webhook](https://docs.snackbase.dev/api-reference/endpoints/webhooks/get-webhook.md): Get details for a specific webhook. - [List Webhook Deliveries](https://docs.snackbase.dev/api-reference/endpoints/webhooks/list-deliveries.md): List delivery history for a webhook (paginated). - [List Webhooks](https://docs.snackbase.dev/api-reference/endpoints/webhooks/list-webhooks.md): List all webhooks configured for the current account. - [Test Webhook](https://docs.snackbase.dev/api-reference/endpoints/webhooks/test-webhook.md): Send a test payload to the webhook URL synchronously and return the result. - [Update Webhook](https://docs.snackbase.dev/api-reference/endpoints/webhooks/update-webhook.md): Update a webhook configuration. - [Cancel Workflow Instance](https://docs.snackbase.dev/api-reference/endpoints/workflows/cancel-workflow-instance.md): Cancel a running or waiting workflow instance. - [Create Workflow](https://docs.snackbase.dev/api-reference/endpoints/workflows/create-workflow.md): Create a new workflow for the current account. - [Delete Workflow](https://docs.snackbase.dev/api-reference/endpoints/workflows/delete-workflow.md): Delete a workflow and all its instances. - [Get Workflow](https://docs.snackbase.dev/api-reference/endpoints/workflows/get-workflow.md): Get a single workflow by ID. - [Get Workflow Instance](https://docs.snackbase.dev/api-reference/endpoints/workflows/get-workflow-instance.md): Get a workflow instance with its step logs. - [List Workflow Instances](https://docs.snackbase.dev/api-reference/endpoints/workflows/list-workflow-instances.md): List instances for a workflow, newest first. - [List Workflows](https://docs.snackbase.dev/api-reference/endpoints/workflows/list-workflows.md): List workflows for the current account. - [Resume Workflow Instance](https://docs.snackbase.dev/api-reference/endpoints/workflows/resume-workflow-instance.md): Resume a failed workflow instance from its last step. - [Toggle Workflow](https://docs.snackbase.dev/api-reference/endpoints/workflows/toggle-workflow.md): Toggle a workflow's enabled/disabled state. - [Trigger Workflow](https://docs.snackbase.dev/api-reference/endpoints/workflows/trigger-workflow.md): Manually trigger a workflow instance. - [Update Workflow](https://docs.snackbase.dev/api-reference/endpoints/workflows/update-workflow.md): Update a workflow definition. - [Trigger Workflow via Webhook](https://docs.snackbase.dev/api-reference/endpoints/workflows/workflow-webhook-trigger.md): Trigger a webhook-type workflow via its secret token. - [API Examples](https://docs.snackbase.dev/api-reference/examples.md): Complete guide to using the SnackBase REST API with practical examples - [API Reference](https://docs.snackbase.dev/api-reference/introduction.md): Interactive API documentation for SnackBase - [Architecture](https://docs.snackbase.dev/architecture.md): Complete architecture overview of SnackBase's clean architecture design - [API-Defined Hooks](https://docs.snackbase.dev/concepts/api-hooks.md): Event-driven automation configured via the REST API -- no code required - [Authentication Model](https://docs.snackbase.dev/concepts/authentication.md): Multi-tenant authentication flows, token management, API keys, OAuth/SAML integration - [Background Jobs](https://docs.snackbase.dev/concepts/background-jobs.md): Asynchronous job execution engine for reliable background processing - [Collections Model](https://docs.snackbase.dev/concepts/collections.md): Dynamic schemas, table generation, and auto-generated APIs - [Custom Endpoints](https://docs.snackbase.dev/concepts/custom-endpoints.md): Define serverless-like HTTP endpoints without writing backend code - [Multi-Tenancy Model](https://docs.snackbase.dev/concepts/multi-tenancy.md): Account isolation, two-tier architecture, and tenant data management - [Realtime System](https://docs.snackbase.dev/concepts/realtime.md): WebSocket and Server-Sent Events for live data updates - [Security Model](https://docs.snackbase.dev/concepts/security.md): Role-based access control, field-level permissions, and rule engine - [Outbound Webhooks](https://docs.snackbase.dev/concepts/webhooks.md): Push notifications to external URLs when data changes in your collections - [Workflow Automation](https://docs.snackbase.dev/concepts/workflows.md): Multi-step automation with branching, delays, and parallel execution - [Deployment Guide](https://docs.snackbase.dev/deployment.md): Deploy SnackBase in development and production environments - [Adding API Endpoints](https://docs.snackbase.dev/guides/adding-api-endpoints.md): Learn how to add new API endpoints to SnackBase following established patterns and architecture - [Building Workflows](https://docs.snackbase.dev/guides/building-workflows.md): Step-by-step guide to creating multi-step automation workflows - [Creating Custom Endpoints](https://docs.snackbase.dev/guides/creating-custom-endpoints.md): Step-by-step guide to building serverless-like HTTP endpoints - [Creating Custom Hooks](https://docs.snackbase.dev/guides/creating-custom-hooks.md): Learn how to create custom hooks in SnackBase to extend functionality and automate workflows - [Extending SnackBase](https://docs.snackbase.dev/guides/extending-snackbase.md): Learn various ways to extend SnackBase functionality beyond the core features - [Frontend Developer Guide](https://docs.snackbase.dev/guides/frontend.md): Complete guide to the SnackBase React admin UI architecture, development patterns, and best practices - [OAuth Authentication Overview](https://docs.snackbase.dev/guides/oauth-overview.md): Understanding the OAuth 2.0 Authorization Code Flow in SnackBase - [Apple OAuth Setup](https://docs.snackbase.dev/guides/oauth-setup-apple.md): Configure Sign in with Apple for SnackBase - [GitHub OAuth Setup](https://docs.snackbase.dev/guides/oauth-setup-github.md): Configure GitHub as an OAuth 2.0 provider for SnackBase - [Google OAuth Setup](https://docs.snackbase.dev/guides/oauth-setup-google.md): Configure Google as an OAuth 2.0 provider for SnackBase - [Microsoft OAuth Setup](https://docs.snackbase.dev/guides/oauth-setup-microsoft.md): Configure Microsoft Azure AD as an OAuth 2.0 provider for SnackBase - [Azure AD SAML Setup](https://docs.snackbase.dev/guides/saml-setup-azure-ad.md): Configure Microsoft Entra ID (Azure AD) as a SAML Identity Provider for SnackBase - [Generic SAML Provider Setup](https://docs.snackbase.dev/guides/saml-setup-generic.md): Configure a generic SAML 2.0 Identity Provider for SnackBase - [Okta SAML Setup](https://docs.snackbase.dev/guides/saml-setup-okta.md): Configure Okta as a SAML Identity Provider for SnackBase - [Setting Up Webhooks](https://docs.snackbase.dev/guides/setting-up-webhooks.md): Step-by-step guide to configuring outbound webhooks for external notifications - [Testing Guide](https://docs.snackbase.dev/guides/testing.md): Learn how to write and run tests for SnackBase, covering unit tests, integration tests, and best practices - [Writing Permission Rules](https://docs.snackbase.dev/guides/writing-rules.md): Learn how to write and use permission rules in SnackBase's rule engine for fine-grained access control - [Hook System Reference](https://docs.snackbase.dev/hooks.md): Complete reference for the SnackBase Hook System v1.0 - a stable extensibility framework - [SnackBase](https://docs.snackbase.dev/index.md) - [SQL Macros](https://docs.snackbase.dev/macros.md): Learn how to use SQL Macros to extend SnackBase's rule engine with custom database logic - [Configuration](https://docs.snackbase.dev/mcp/configuration.md): Configure the SnackBase MCP server for your needs - [MCP Server](https://docs.snackbase.dev/mcp/index.md): Integrate SnackBase with AI assistants using the Model Context Protocol (MCP) - [Installation](https://docs.snackbase.dev/mcp/installation.md): Install and set up the SnackBase MCP server - [Integration Guide](https://docs.snackbase.dev/mcp/integration.md): Use the SnackBase MCP server with Claude Code, Cursor, and other AI assistants - [Tools Reference](https://docs.snackbase.dev/mcp/tools/index.md): Complete reference for all SnackBase MCP tools - [Permissions & Authorization](https://docs.snackbase.dev/permissions.md): Complete guide to SnackBase's collection-centric access control rules - [Quick Start Guide](https://docs.snackbase.dev/quickstart.md): Get up and running with SnackBase in 5 minutes - [API Key Authentication](https://docs.snackbase.dev/sdk/js/auth/api-keys.md): Use API keys for server-to-server authentication - [Email and Password Authentication](https://docs.snackbase.dev/sdk/js/auth/email-password.md): Implement traditional email and password authentication - [OAuth Authentication](https://docs.snackbase.dev/sdk/js/auth/oauth.md): Implement OAuth social login with Google, GitHub, and more - [Authentication Overview](https://docs.snackbase.dev/sdk/js/auth/overview.md): Understand authentication in the SnackBase JavaScript SDK - [New in v0.3.0](https://docs.snackbase.dev/sdk/js/auth/v0.3.0-changes.md): Authentication enhancements in SDK v0.3.0 - [Configuration](https://docs.snackbase.dev/sdk/js/configuration.md): Configure the SnackBase JavaScript SDK for your needs - [Error Handling Overview](https://docs.snackbase.dev/sdk/js/errors/overview.md): Handle errors in the SnackBase JavaScript SDK - [Error Types Reference](https://docs.snackbase.dev/sdk/js/errors/types.md): Complete reference for all SDK error types - [Installation](https://docs.snackbase.dev/sdk/js/installation.md): Install and configure the SnackBase JavaScript SDK in your project - [Filtering Queries](https://docs.snackbase.dev/sdk/js/query/filtering.md): Filter records with complex conditions - [Query Builder Overview](https://docs.snackbase.dev/sdk/js/query/overview.md): Build complex queries with the fluent query builder API - [Paginating Queries](https://docs.snackbase.dev/sdk/js/query/pagination.md): Paginate large result sets efficiently - [Sorting Queries](https://docs.snackbase.dev/sdk/js/query/sorting.md): Sort query results by one or more fields - [Quick Start](https://docs.snackbase.dev/sdk/js/quickstart.md): Get up and running with the SnackBase JavaScript SDK in minutes - [React Setup](https://docs.snackbase.dev/sdk/js/react/setup.md): Set up SnackBase SDK with React - [useAuth Hook](https://docs.snackbase.dev/sdk/js/react/use-auth.md): Handle authentication in React components - [useMutation Hook](https://docs.snackbase.dev/sdk/js/react/use-mutation.md): Perform mutations on records in React components - [useQuery Hook](https://docs.snackbase.dev/sdk/js/react/use-query.md): Build queries with the query builder in React - [useRecord Hook](https://docs.snackbase.dev/sdk/js/react/use-record.md): Fetch single records in React components - [useSubscription Hook](https://docs.snackbase.dev/sdk/js/react/use-subscription.md): Subscribe to real-time updates in React components - [Realtime Events](https://docs.snackbase.dev/sdk/js/realtime/events.md): Reference for realtime events and listeners - [Realtime Overview](https://docs.snackbase.dev/sdk/js/realtime/overview.md): Build real-time features with WebSocket and SSE - [Server-Sent Events (SSE)](https://docs.snackbase.dev/sdk/js/realtime/sse.md): Use Server-Sent Events for real-time updates - [WebSocket Realtime](https://docs.snackbase.dev/sdk/js/realtime/websocket.md): Use WebSocket for low-latency real-time updates - [Client Reference](https://docs.snackbase.dev/sdk/js/reference/client.md): Complete reference for the SnackBaseClient class - [Type Reference](https://docs.snackbase.dev/sdk/js/reference/types.md): TypeScript type definitions for the SDK - [Accounts Service](https://docs.snackbase.dev/sdk/js/services/accounts.md): Manage accounts in your SnackBase instance - [Admin Service](https://docs.snackbase.dev/sdk/js/services/admin.md): Manage system configuration and providers - [API Keys Service](https://docs.snackbase.dev/sdk/js/services/api-keys.md): Manage API keys for service-to-service authentication - [Audit Logs Service](https://docs.snackbase.dev/sdk/js/services/audit-logs.md): View and export audit logs - [Collection Rules Service](https://docs.snackbase.dev/sdk/js/services/collection-rules.md): Manage access rules and field permissions for collections - [Collections Service](https://docs.snackbase.dev/sdk/js/services/collections.md): Manage collections and their schemas - [Dashboard Service](https://docs.snackbase.dev/sdk/js/services/dashboard.md): Retrieve dashboard statistics and metrics - [Email Templates](https://docs.snackbase.dev/sdk/js/services/email-templates.md): Manage email templates with the SnackBase JavaScript SDK - [Endpoints Service](https://docs.snackbase.dev/sdk/js/services/endpoints.md): Manage custom serverless-like HTTP endpoints - [Files Service](https://docs.snackbase.dev/sdk/js/services/files.md): Upload, download, and delete files - [Groups Service](https://docs.snackbase.dev/sdk/js/services/groups.md): Manage user groups for easier access control - [Hooks Service](https://docs.snackbase.dev/sdk/js/services/hooks.md): Manage API-defined hooks with event, schedule, and manual triggers - [Invitations Service](https://docs.snackbase.dev/sdk/js/services/invitations.md): Invite users to join your account - [Jobs Service](https://docs.snackbase.dev/sdk/js/services/jobs.md): Monitor and manage background jobs (superadmin only) - [Macros Service](https://docs.snackbase.dev/sdk/js/services/macros.md): Manage SQL macros for use in permission rules - [Migrations Service](https://docs.snackbase.dev/sdk/js/services/migrations.md): View migration status and history - [Records Service](https://docs.snackbase.dev/sdk/js/services/records.md): Perform CRUD operations on dynamic collections - [Roles Service](https://docs.snackbase.dev/sdk/js/services/roles.md): Manage roles and permissions for access control - [Users Service](https://docs.snackbase.dev/sdk/js/services/users.md): Manage users in your SnackBase account - [Webhooks Service](https://docs.snackbase.dev/sdk/js/services/webhooks.md): Manage outbound webhooks and delivery history - [Workflows Service](https://docs.snackbase.dev/sdk/js/services/workflows.md): Create and manage multi-step workflow automations ## OpenAPI Specs - [openapi](https://docs.snackbase.dev/api-reference/openapi.json)