# MQUAD Platform

## User Manual

- [Introduction to MQUAD](/user-manual/introduction.md): Platform overview, key features, and supported use cases for the MQUAD survey management platform
- [Quickstart Guide](/user-manual/quickstart.md): Get started with MQUAD — create an account, build a survey, grant access, collect responses, and view results
- [Account Setup](/user-manual/account-setup.md): Registration, login, password reset, profile settings, and session management for MQUAD
- [Workspaces](/user-manual/workspaces.md): Organize your projects and surveys into workspaces for better team collaboration and management
- [Projects](/user-manual/projects.md): Manage projects within workspaces to organize surveys and track progress
- [Surveys](/user-manual/surveys.md): Create, manage, and organize surveys from a workspace and project, including the Create Form dialog, templates, question banks, and survey lifecycle management
- [Fill Forms](/user-manual/forms.md): Browse forms shared with you, start new interviews, and jump to the Resume Center
- [Survey Designer](/user-manual/survey-designer.md): Complete reference for the visual survey designer — interface, every question type's configuration and runtime behavior, choices, appearance, languages, skip logic, validation rules, calculated values, constraint expressions, and preview
- [Templates](/user-manual/templates.md): Create, manage, and organize reusable survey templates and template categories
- [Question Bank](/user-manual/question-bank.md): Create, manage, and organize reusable questions for your surveys
- [Form Logic Overview](/user-manual/form-logic-overview.md): The four ways to add logic to a survey — validation, skip logic, default values, and calculations — and how question references work
- [Validation](/user-manual/validation.md): How validation (constraints) decides whether an entered answer is acceptable — rules, operators, messages, and examples
- [Skip Logic](/user-manual/skip-logic.md): How skip logic (relevance) controls whether a question is shown, with conditions, AND/OR logic, and nested groups
- [Default Values](/user-manual/default-values.md): Setting default values for survey questions using the
- [Auto-Populate and Calculations](/user-manual/calculation-expressions.md): Writing calculation expressions, auto-populated fields, and computed values in forms, with the frozen calculation function set
- [Expression Reference](/user-manual/expression-reference.md): The complete reference for expression operators and every verified built-in function across web, mobile, and backend
- [Date and Time Reference](/user-manual/date-time-reference.md): How MQUAD handles dates, datetimes, and plain times in expressions — formats, completed units, month-end clamping, and time-diff rules
- [Common Recipes](/user-manual/common-recipes.md): Copy-and-adapt calculation, validation, and skip logic recipes for real surveys
- [Blank and Invalid Values](/user-manual/blank-and-invalid-values.md): What happens when expressions receive missing, blank, malformed, or out-of-order values
- [XLSForm Mapping](/user-manual/xlsform-mapping.md): How validation, skip logic, default values, and calculations map to XLSForm columns, and which features are MQUAD extensions
- [Troubleshooting Expressions](/user-manual/troubleshooting-expressions.md): Common expression mistakes and how to fix them — wrong references, argument order, quoting, units, and more
- [Data Viewer](/user-manual/data-viewer.md): View, analyze, export, and manage survey responses
- [Collecting Responses](/user-manual/collecting-responses.md): Data collection modes, distribution methods, and monitoring response rates in MQUAD
- [Response Approval Workflow](/user-manual/response-approval.md): Configuring and using the response approval workflow, reviewing responses, approve/reject actions, bulk approval, and audit trail
- [Supervisor Reviews](/user-manual/supervisor-reviews.md): The Supervisor Review Queue for reviewing, approving, rejecting, and flagging completed interviews
- [Response Editing](/user-manual/response-editing.md): Editing submitted responses, edit permissions, audit trail for edits, and version history
- [Bulk Operations](/user-manual/bulk-operations.md): Management of large data volumes through ODK synchronization, bulk export, and administrative batch actions
- [Sync Conflicts](/user-manual/sync-conflicts.md): Version: 1.0 Last Updated: 2026-07-16
- [Duplicate Review](/user-manual/duplicate-review.md): Review and manage potential duplicate survey responses
- [Random Sampling](/user-manual/random-sampling.md): Generate random samples from uploaded CSV or Excel files
- [Interview Lifecycle](/user-manual/interview-lifecycle.md): Manage survey interviews through their full lifecycle - start, pause, resume, complete, revise, and terminate
- [Mobile App Overview & Setup](/user-manual/mobile-overview.md): Introduction to the MQUAD mobile field app, installation, multi-tenant sign-in, security, and dashboard navigation.
- [Filling Surveys on Mobile](/user-manual/mobile-form-filling.md): Comprehensive guide to starting, navigating, answering, reviewing, and submitting questionnaires in the MQUAD mobile app.
- [Offline Data Collection & Synchronization](/user-manual/mobile-offline-sync.md): Working offline in remote field settings, automatic background sync, conflict resolution, and device storage management.
- [Mobile Field Troubleshooting & Diagnostics](/user-manual/mobile-troubleshooting.md): Troubleshooting guide for field enumerators, diagnostic tools, log export, and frequently asked questions for the MQUAD mobile app.
- [Users](/user-manual/users.md): Manage users, invite new users, and assign roles
- [Roles](/user-manual/roles.md): Manage roles and permissions to control access to the application
- [Roles & Permissions](/user-manual/roles-permissions.md): Role hierarchy, permission matrix, and granular permission-based access control in MQUAD
- [Tenant Management](/user-manual/tenant-management.md): Workspace administration, tenant isolation, branding, and tenant-level settings in MQUAD
- [Data Export Formats](/user-manual/data-export-formats.md): Detailed format specifications, encoding, and missing values handling for MQUAD exports
- [Settings](/user-manual/settings.md): Configure your application settings, including storage, notifications, media library, billing, and more
- [Stripe Payments](/user-manual/stripe-payments.md): Payment setup, subscription plans, billing, invoices, and payment history in MQUAD
- [Webhooks](/user-manual/webhooks.md): Manage webhook subscriptions and monitor delivery status
- [Audit Logging](/user-manual/audit-logging.md): Activity log overview, event types, and searching logs in MQUAD
- [Consent Management](/user-manual/consent-management.md): Implementing informed consent within MQUAD surveys using specialized question types and signatures
- [Subscriptions](/user-manual/subscriptions.md): Plan comparison, upgrading and downgrading, billing cycle management, and cancellation in MQUAD
- [Frequently Asked Questions](/user-manual/faq.md): Common questions about MQUAD organized by category — account, surveys, responses, data, billing, and troubleshooting

## Technical Docs

- [Architecture Overview](/technical-docs/technical/architecture-overview.md): High-level system architecture of the MQUAD multi-tenant microservices platform
- [System Topology](/technical-docs/technical/system-topology.md): Network topology, service discovery, and port allocation for MQUAD microservices
- [Service Map](/technical-docs/technical/service-map.md): Complete service catalog with ports, purposes, dependencies, databases, and health endpoints
- [Microservices Overview](/technical-docs/technical/microservices/overview.md): Summary of all 14 microservices with ports, purposes, base paths, and database names
- [Backend Service](/technical-docs/technical/microservices/backend.md): Core API service handling authentication, user management, RBAC, tenant administration, and Stripe billing
- [Survey Service](/technical-docs/technical/microservices/survey-service.md): Survey design engine supporting XLSForm import/export, versioning, and complex question types
- [Form Service](/technical-docs/technical/microservices/form-service.md): Dynamic web form rendering, expression engine, constraint evaluation, and submission processing
- [Data Service](/technical-docs/technical/microservices/data-service.md): Response data storage, processing, bulk operations, and export pipeline
- [Analytics Service](/technical-docs/technical/microservices/analytics-service.md): Analytics engine for dashboards, aggregations, reports, and data snapshots
- [Sync Service](/technical-docs/technical/microservices/sync-service.md): Data synchronization between online/offline modes, conflict resolution, and delta sync
- [Sync Conflicts - Technical Manual](/technical-docs/technical/sync-conflicts.md): Version: 1.0 Last Updated: 2026-07-16
- [Sync Conflicts - Quality Requirements](/technical-docs/technical/sync-conflicts-quality.md): Version: 1.0 Last Updated: 2026-07-16
- [Workspace Service](/technical-docs/technical/microservices/workspace-service.md): Workspace and project management with tenant workspace isolation and collaboration
- [Webhook Service](/technical-docs/technical/microservices/webhook-service.md): Webhook delivery system with event subscriptions, retry logic, and Redis event consumption
- [Audit Service](/technical-docs/technical/microservices/audit-service.md): Structured audit logging with event taxonomy, log retention policies, and query API
- [Media Service](/technical-docs/technical/microservices/media-service.md): File upload and download service with S3/MinIO storage backend and image processing
- [Notification Service](/technical-docs/technical/microservices/notification-service.md): Multi-channel notification delivery via Email, SMS, and Slack with template management
- [Feature Flags Service](/technical-docs/technical/microservices/feature-flags.md): Feature flag management system with A/B testing support and flag evaluation SDK
- [Quota Service](/technical-docs/technical/microservices/quota-service.md): Real-time quota tracking and plan enforcement for multi-tenant rate limiting and resource caps
- [Mobile Application Architecture](/technical-docs/technical/mobile/architecture.md): Deep dive into the MQUAD Flutter field app architecture, clean layer organization, multi-tenancy, and state management.
- [Form Runtime Engine & Semantics](/technical-docs/technical/mobile/form-engine.md): Technical architecture of the MQUAD mobile form engine, XLSForm expression evaluation, SafeHtml rendering, and validation.
- [Offline Synchronization Engine](/technical-docs/technical/mobile/offline-sync-engine.md): Architecture of the MQUAD mobile synchronization pipeline, background processing, conflict reconciliation, and chunked media upload.
- [Security, Cryptography & Data Sovereignty](/technical-docs/technical/mobile/security-data-sovereignty.md): Architectural specifications for AES-256 SQLCipher database encryption, hardware key storage, biometric gating, and mobile data sovereignty.
- [Developer Setup & Build Guide](/technical-docs/technical/mobile/developer-setup.md): Complete instructions for configuring the local Flutter development environment, running tests, code generation, and multi-platform compilation.
- [Deployment Overview](/technical-docs/technical/deployment/overview.md): Deployment architecture, environment requirements, Docker vs bare metal considerations, and networking
- [Docker Compose (Local Development)](/technical-docs/technical/deployment/docker-compose.md): Local development setup with dev.compose.yaml, environment variables, and common gotchas
- [Production Deployment](/technical-docs/technical/deployment/production.md): Production deployment with Traefik TLS, secrets management, database backups, and scaling considerations
- [Tenant Hosting](/technical-docs/technical/deployment/tenant-hosting.md): Tenant data hosting options including dedicated databases, shared databases, and isolation strategies
- [Monitoring](/technical-docs/technical/deployment/monitoring.md): Prometheus metrics, Grafana dashboards, Loki log aggregation, and Jaeger distributed tracing
- [Frontend Layout Tree](/technical-docs/technical/development/frontend-layout-tree.md): Layout architecture for the React 19 web application including scroll ownership, routing, and viewport handling
- [Audit Event Taxonomy](/technical-docs/technical/development/audit-event-taxonomy.md): Complete reference of all audit event types, actions, and schemas across MQUAD services
- [Audit Service Configuration](/technical-docs/technical/development/audit-service-configuration.md): Architecture, endpoints, middleware setup, and troubleshooting for the centralized audit-service
- [Calendar Grid Implementation](/technical-docs/technical/development/calendar-grid-implementation.md): Technical reference for the calendar grid question type - schema, validation, frontend rendering, and XLSForm import/export
- [Lookup Trigger Assignment](/technical-docs/technical/development/lookup-trigger-assignment.md): Implementation report for assigning specific lookup data triggers to individual enumerators via Manage Form Access
- [Media Export Implementation](/technical-docs/technical/development/media-export-implementation.md): Asynchronous downloading of survey media files using Celery and Redis with S3 storage and email notifications
- [Plan Enforcement](/technical-docs/technical/development/plan-enforcement.md): Plan limits by tier, feature flag mappings, integration status, and corrected default values for quota enforcement
- [Survey Data Tools Standards](/technical-docs/technical/development/survey-data-tools-standards.md): Industry-standard survey tools and features benchmarked against major platforms for core MQUAD services
- [Comprehensive Permission Analysis](/technical-docs/technical/development/comprehensive-permissions.md): Complete inventory of all 135+ permissions across 14 microservices with sync status, role matrix, and critical security findings
- [Multi-Tenancy](/technical-docs/technical/guides/multi-tenancy.md): Implementation guide for multi-tenancy including X-Tenant-ID header, middleware, RBAC helpers, and query filtering
- [Authentication](/technical-docs/technical/guides/authentication.md): Authentication flow covering JWT access/refresh tokens, OAuth2, WebAuthn passkeys, magic links, and RBAC permission checks
- [Event System](/technical-docs/technical/guides/event-system.md): Redis Pub/Sub event architecture, webhook:events channel, best-effort delivery, and publisher/subscriber patterns
- [Stripe Integration](/technical-docs/technical/guides/stripe-integration.md): Stripe payment integration covering customer creation, subscription management, webhook handling, billing portal, and test mode
- [Audit Logging](/technical-docs/technical/guides/audit-logging.md): Structured audit logging with event taxonomy, log format, integrity verification, retention policies, and query API
- [Response Approval](/technical-docs/technical/guides/response-approval.md): Response approval workflow covering states, approval chains, notifications, and audit events
- [Response Editing](/technical-docs/technical/guides/response-editing.md): Response editing rules, version tracking, audit trail, and conflict detection
- [Template Management](/technical-docs/technical/guides/template-management.md): Survey template lifecycle including creation, publishing, versioning, permissions, and import/export
- [Default Values](/technical-docs/technical/guides/default-values.md): Default value expression syntax, resolution rules, validation pipeline, and runtime architecture
- [Calculation Engine](/technical-docs/technical/guides/calculation-engine.md): Expression engine architecture, function registry, evaluation lifecycle, and cross-platform parity
- [Permissions & RBAC](/technical-docs/technical/guides/permissions.md): RBAC model including permission enums, role hierarchy, permission checks via common/rbac_helpers.py, and permission matrix
- [Calendar Rules Engine](/technical-docs/technical/guides/calendar-rules.md): Calendar-based rules engine for date-based survey activation/deactivation, scheduling logic, and recurring rules
- [Consent Management](/technical-docs/technical/guides/consent-management.md): Consent management covering consent form creation, consent tracking, withdrawal, and audit trail
- [Pagination Standards](/technical-docs/technical/guides/pagination-standards.md): Skip-offset pagination convention across all services with standardized response format
- [Interview Lifecycle - Technical Manual](/technical-docs/technical/interview-lifecycle.md): Version: 1.0 Last Updated: 2026-07-16
- [Interview Lifecycle API Reference](/technical-docs/technical/interview-lifecycle-api.md): Version: 1.0 Last Updated: 2026-07-16

## API Reference

- [MQUAD Platform - Unified API Documentation](/api-reference.md): Complete API reference for all MQUAD microservices, consolidated from each service's live OpenAPI specification.
- [Health Check](/api-reference/operations/operation-api-v1-health-get.md): Also served by Survey Service at http://localhost:8001.
- [Get System Metrics](/api-reference/operations/operation-api-v1-system-metrics-get.md): GET /api/v1/system-metrics: returns Backend_SystemMetricsResponseDto.
- [List Tenants](/api-reference/operations/operation-api-v1-tenants-get.md): GET /api/v1/tenants: returns Backend_TenantListDto.
- [Create Tenant](/api-reference/operations/operation-api-v1-tenants-post.md): POST /api/v1/tenants: takes Backend_CreateTenantDto, returns Backend_CreateTenantResponseDto.
- [Delete Tenant](/api-reference/operations/operation-api-v1-tenants-id-delete.md): DELETE /api/v1/tenants/{id}.
- [Search By Name](/api-reference/operations/operation-api-v1-tenants-search-by-name-name-get.md): GET /api/v1/tenants/search_by_name/{name}: returns Backend_TenantDto.
- [Search By Subdomain](/api-reference/operations/operation-api-v1-tenants-search-by-subdomain-subdomain-get.md): GET /api/v1/tenants/search_by_subdomain/{subdomain}: returns Backend_TenantDto.
- [Check Subdomain Availability](/api-reference/operations/operation-api-v1-tenants-check-subdomain-subdomain-get.md): GET /api/v1/tenants/check_subdomain/{subdomain}: returns Backend_SubdomainAvailabilityDto.
- [Get Reserved Subdomains](/api-reference/operations/operation-api-v1-tenants-reserved-subdomains-get.md): Get list of reserved subdomains that cannot be used for tenant creation.
- [Update Tenant Dns Record](/api-reference/operations/operation-api-v1-tenants-tenant-id-update-dns-post.md): When bringing your own domain you must map the DNS records for your custom domain to point to our main domain. You can do this by adding a CNAME record in your domain's DNS settings. Here is an example of how to set it up: Type: CNAME Name: app Value: mquad.local
- [Check Dns Status](/api-reference/operations/operation-api-v1-tenants-tenant-id-check-dns-get.md): GET /api/v1/tenants/{tenant_id}/check_dns: returns Backend_UpdateTenantResponseDto.
- [Get Dns Details](/api-reference/operations/operation-api-v1-tenants-tenant-id-dns-details-get.md): Get detailed DNS information for a tenant.
- [Update Tenant](/api-reference/operations/operation-api-v1-tenants-tenant-id-put.md): PUT /api/v1/tenants/{tenant_id}: takes Backend_UpdateTenantDto.
- [Get Tenant Features](/api-reference/operations/operation-api-v1-tenants-tenant-id-features-get.md): GET /api/v1/tenants/{tenant_id}/features: returns a list of Backend_FeatureDto.
- [Update Tenant Feature](/api-reference/operations/operation-api-v1-tenants-tenant-id-update-feature-patch.md): PATCH /api/v1/tenants/{tenant_id}/update_feature: takes Backend_FeatureDto, returns Backend_UpdateTenantResponseDto.
- [Activate Trial Plan](/api-reference/operations/operation-api-v1-tenants-tenant-id-activate-trial-plan-patch.md): Activate a trial subscription by creating a real Stripe subscription.
- [Update Tenant Billing Address](/api-reference/operations/operation-api-v1-tenants-tenant-id-billing-address-put.md): Update tenant billing address and optionally tax ID.
- [Get Tenant Plan Tier](/api-reference/operations/operation-api-v1-tenants-tenant-id-plan-tier-get.md): Get the plan tier for a tenant.
- [Get Tenant Plan Context](/api-reference/operations/operation-api-v1-tenants-tenant-id-plan-context-get.md): Return tenant billing state used by feature-flags-service plan resolution.
- [Enterprise Signup](/api-reference/operations/operation-api-v1-tenants-tenant-id-enterprise-signup-post.md): Submit an enterprise plan inquiry. Sends the inquiry to the sales team via notification-service using the enterprise_signup template. Uses tenant admin's name and tenant name as defaults.
- [Cancel Tenant Subscription](/api-reference/operations/operation-api-v1-tenants-tenant-id-cancel-subscription-post.md): Host admin endpoint to cancel a tenant's Stripe subscription. Downgrades the tenant to Free plan and clears dormant state.
- [List Features](/api-reference/operations/operation-api-v1-features-get.md): List all available features. Requires HOST_MANAGE_TENANTS permission.
- [Get App Configuration](/api-reference/operations/operation-api-v1-app-configuration-get.md): GET /api/v1/app_configuration: returns Backend_AppConfigurationDto.
- [Login New](/api-reference/operations/operation-api-v1-account-login-new-post.md): New login endpoint - authenticate and return user info with tenant list. Does not require tenant selection. User selects tenant in separate step.
- [Login Super Admin](/api-reference/operations/operation-api-v1-account-login-super-admin-post.md): Super admin login endpoint - authenticate and return tokens directly. Super admins have system-wide access without tenant selection.
- [Login Host Admin](/api-reference/operations/operation-api-v1-account-login-host-admin-post.md): Host admin login endpoint - for users without a specific tenant (host-level access). Returns tokens for users who have access to the host system but no tenant.
- [Select Tenant](/api-reference/operations/operation-api-v1-account-select-tenant-post.md): After login, select a tenant and get access tokens. Super admins skip tenant selection.
- [Switch Tenant](/api-reference/operations/operation-api-v1-account-switch-tenant-post.md): Switch the user's active tenant mid-session. Requires a valid session token (not a pre-auth token). Issues entirely new access + refresh tokens scoped to the target tenant. The previous tenant_id comes from the current JWT's tenant_id claim.
- [Login](/api-reference/operations/operation-api-v1-account-login-post.md): POST /api/v1/account/login: takes Backend_Body_login_api_v1_account_login_post, returns Backend_TokenSetDto.
- [Refresh Token](/api-reference/operations/operation-api-v1-account-refresh-post.md): POST /api/v1/account/refresh: returns Backend_TokenSetDto.
- [Logout](/api-reference/operations/operation-api-v1-account-logout-get.md): GET /api/v1/account/logout.
- [Logout](/api-reference/operations/operation-api-v1-account-logout-post.md): POST /api/v1/account/logout.
- [Register](/api-reference/operations/operation-api-v1-account-register-post.md): POST /api/v1/account/register: takes Backend_CreateUserDto.
- [Read Users Me](/api-reference/operations/operation-api-v1-account-me-get.md): GET /api/v1/account/me: returns Backend_MeResponseDto.
- [Password Reset Request](/api-reference/operations/operation-api-v1-account-password-reset-request-post.md): POST /api/v1/account/password_reset_request: takes Backend_PasswordResetRequestDto, returns Backend_PasswordResetResponseDto.
- [Password Reset Confirm](/api-reference/operations/operation-api-v1-account-password-reset-confirmation-post.md): POST /api/v1/account/password_reset_confirmation: takes Backend_PasswordResetConfirmRequestDto, returns Backend_PasswordResetResponseDto.
- [Resend Activation Email](/api-reference/operations/operation-api-v1-account-resend-activation-email-post.md): POST /api/v1/account/resend_activation_email: takes Backend_UserResendActivationEmailRequestDto.
- [Resend Activation Email Public](/api-reference/operations/operation-api-v1-account-resend-activation-post.md): Public resend of the account activation email, used by the account activation gate page for users whose accounts are inactive. Sending is refused for already-active accounts (InvalidOperationException).
- [Activate Account](/api-reference/operations/operation-api-v1-account-activate-post.md): POST /api/v1/account/activate: takes Backend_UserActivationRequestDto.
- [Change Email](/api-reference/operations/operation-api-v1-account-change-email-request-patch.md): PATCH /api/v1/account/change_email_request: takes Backend_ChangeEmailRequestDto.
- [Change Email Confirmation](/api-reference/operations/operation-api-v1-account-change-email-confirmation-patch.md): PATCH /api/v1/account/change_email_confirmation: takes Backend_ChangeEmailConfirmRequestDto, returns Backend_ChangeEmailResponseDto.
- [Passkey Register Options](/api-reference/operations/operation-api-v1-account-passkey-register-options-post.md): POST /api/v1/account/passkey/register_options.
- [Passkey Register](/api-reference/operations/operation-api-v1-account-passkey-register-post.md): POST /api/v1/account/passkey/register: takes Backend_Body_passkey_register_api_v1_account_passkey_register_post.
- [Passkey Login Options](/api-reference/operations/operation-api-v1-account-passkey-login-options-post.md): POST /api/v1/account/passkey/login_options.
- [Passkey Login](/api-reference/operations/operation-api-v1-account-passkey-login-post.md): POST /api/v1/account/passkey/login: takes Backend_Body_passkey_login_api_v1_account_passkey_login_post, returns Backend_LoginResponseDto.
- [Has Passkeys](/api-reference/operations/operation-api-v1-account-passkey-has-passkeys-post.md): POST /api/v1/account/passkey/has_passkeys: returns Backend_HasPasskeysDto.
- [Email Magic Link Login](/api-reference/operations/operation-api-v1-account-email-magic-link-login-post.md): POST /api/v1/account/email_magic_link_login: returns Backend_MagicLinkResponseDto.
- [Email Magic Link Validate](/api-reference/operations/operation-api-v1-account-email-magic-link-validate-get.md): GET /api/v1/account/email_magic_link_validate: returns Backend_LoginResponseDto.
- [Get Registered Passkeys](/api-reference/operations/operation-api-v1-security-passkeys-get.md): Endpoint to retrieve registered passkeys for the current user.
- [Delete Registered Passkey](/api-reference/operations/operation-api-v1-security-passkeys-credential-id-delete.md): Endpoint to delete a registered passkey for the current user.
- [Get Dashboard Metrics](/api-reference/operations/operation-api-v1-dashboard-get.md): GET /api/v1/dashboard: returns Backend_DashboardMetricsDto.
- [Get Superadmin Dashboard](/api-reference/operations/operation-api-v1-superadmin-dashboard-get.md): Get superadmin dashboard with platform-wide metrics.
- [List Users](/api-reference/operations/operation-api-v1-users-get.md): GET /api/v1/users: returns Backend_UserListDto.
- [Create User](/api-reference/operations/operation-api-v1-users-post.md): POST /api/v1/users: takes Backend_CreateUserDto, returns Backend_CreateUserResponseDto.
- [Search User By Email](/api-reference/operations/operation-api-v1-users-search-by-email-get.md): Search for a user by their email address within the current tenant context. Returns user details if found, useful for workspace member invitations.
- [Search Users With Roles](/api-reference/operations/operation-api-v1-users-search-with-roles-get.md): Search users with role filtering.
- [Get Users Bulk](/api-reference/operations/operation-api-v1-users-bulk-post.md): Fetch multiple users by their IDs in bulk, scoped to the current tenant. Prevents cross-tenant user enumeration.
- [Provision User](/api-reference/operations/operation-api-v1-users-provision-post.md): Provision a user to the current tenant.
- [Get Available Roles](/api-reference/operations/operation-api-v1-users-available-roles-get.md): GET /api/v1/users/available-roles.
- [Count Users](/api-reference/operations/operation-api-v1-users-count-get.md): Count users in the current tenant, optionally filtered by account active status and/or role name (e.g. "Enumerator"). Super admins count across all tenants when no role filter is applied.
- [Get User](/api-reference/operations/operation-api-v1-users-user-id-get.md): Get a single user by ID, scoped to the current tenant. Non-super-admin users can only retrieve users belonging to their active tenant.
- [Update User](/api-reference/operations/operation-api-v1-users-user-id-put.md): PUT /api/v1/users/{user_id}: takes Backend_UpdateUserDto, returns Backend_UserDto.
- [Delete User](/api-reference/operations/operation-api-v1-users-user-id-delete.md): DELETE /api/v1/users/{user_id}.
- [Get Profile Image](/api-reference/operations/operation-api-v1-users-profile-image-key-get.md): GET /api/v1/users/profile/{image_key}: returns Backend_UserProfileImageUpdateDto.
- [Update User Tenant Access](/api-reference/operations/operation-api-v1-users-user-id-tenant-access-patch.md): Activate or deactivate a user's membership in the active tenant.
- [Update Profile Picture](/api-reference/operations/operation-api-v1-users-user-id-update-profile-picture-put.md): PUT /api/v1/users/{user_id}/update_profile_picture: takes Backend_Body_update_profile_picture_api_v1_users__user_id__update_profile_picture_put, returns Backend_UserProfileImageUpdateDto.
- [Delete Profile Picture](/api-reference/operations/operation-api-v1-users-user-id-delete-profile-picture-delete.md): DELETE /api/v1/users/{user_id}/delete_profile_picture: returns Backend_UserProfileImageUpdateDto.
- [Patch User](/api-reference/operations/operation-api-v1-users-user-id-assign-role-patch.md): PATCH /api/v1/users/{user_id}/assign_role: takes Backend_UserRoleUpdateRequestDto, returns Backend_UserDto.
- [Remove User Role](/api-reference/operations/operation-api-v1-users-user-id-remove-role-patch.md): PATCH /api/v1/users/{user_id}/remove_role: takes Backend_UserRoleUpdateRequestDto, returns Backend_UserDto.
- [Get My Tenants](/api-reference/operations/operation-api-v1-users-me-tenants-get.md): Get all tenants for the currently authenticated user. This endpoint is accessible to all authenticated users.
- [Get User Tenants](/api-reference/operations/operation-api-v1-users-user-id-tenants-get.md): Get all tenants for a user. Users can view their own tenants. Platform admins can view any user's tenants. Tenant admins can only view memberships for their own authorized tenant(s).
- [Add User To Tenant](/api-reference/operations/operation-api-v1-users-user-id-tenants-post.md): Add a user to a tenant. Only users with USER_READ_AND_WRITE_ONLY permission can add users to tenants.
- [Update User Tenant](/api-reference/operations/operation-api-v1-users-user-id-tenants-user-tenant-id-put.md): Update a user-tenant relationship (change role or primary status). Only users with USER_READ_AND_WRITE_ONLY permission can update.
- [Remove User From Tenant](/api-reference/operations/operation-api-v1-users-user-id-tenants-user-tenant-id-delete.md): Remove a user from a tenant. Only users with USER_DELETE_ONLY permission can remove users from tenants.
- [Set Primary Tenant](/api-reference/operations/operation-api-v1-users-user-id-tenants-set-primary-post.md): Set a tenant as the primary tenant for a user. Users can set their own primary tenant. Admins can set for any user.
- [Get Primary Tenant](/api-reference/operations/operation-api-v1-users-user-id-tenants-primary-get.md): Get the primary tenant for a user. Users can view their own primary tenant. Admins can view for any user.
- [Switch Primary Tenant](/api-reference/operations/operation-api-v1-users-me-tenants-switch-post.md): Switch the primary tenant for the currently authenticated user. The user must already be a member of the tenant.
- [Bulk Upload Users](/api-reference/operations/operation-api-v1-users-bulk-upload-post.md): Bulk upload users to a tenant from CSV or Excel file.
- [List Roles](/api-reference/operations/operation-api-v1-roles-get.md): GET /api/v1/roles: returns Backend_RoleListDto.
- [Create Role](/api-reference/operations/operation-api-v1-roles-post.md): POST /api/v1/roles: takes Backend_CreateRoleDto, returns Backend_CreateRoleResponseDto.
- [Search Role By Name](/api-reference/operations/operation-api-v1-roles-search-by-name-get.md): GET /api/v1/roles/search_by_name: returns a list of Backend_RoleDto.
- [Update Role Permissions](/api-reference/operations/operation-api-v1-roles-role-id-permissions-patch.md): Update role permissions only (for inline editing in Role Details).
- [Get Role](/api-reference/operations/operation-api-v1-roles-role-id-get.md): GET /api/v1/roles/{role_id}: returns Backend_RoleDto.
- [Update Role](/api-reference/operations/operation-api-v1-roles-role-id-put.md): PUT /api/v1/roles/{role_id}: takes Backend_UpdateRoleDto.
- [Delete Role](/api-reference/operations/operation-api-v1-roles-role-id-delete.md): Deletes a role if it is not assigned to any users.
- [Sync Admin Permissions](/api-reference/operations/operation-api-v1-roles-sync-admin-permissions-post.md): Sync ADMIN role permissions with the latest from seeder_utils. Use this after adding new permissions.
- [Sync User Permissions](/api-reference/operations/operation-api-v1-roles-sync-user-permissions-post.md): Sync USER role permissions with the latest from seeder_utils. Use this after adding new permissions.
- [Get Grouped Permissions](/api-reference/operations/operation-api-v1-roles-grouped-permissions-get.md): Get permissions grouped by category for enterprise permission management UI
- [Get Role Stats](/api-reference/operations/operation-api-v1-roles-role-id-stats-get.md): Get role statistics including assigned users count
- [Get Role Users](/api-reference/operations/operation-api-v1-roles-role-id-users-get.md): List users assigned to a role (checks both users.role_id and user_tenants.role_id).
- [Get Permissions](/api-reference/operations/operation-api-v1-permissions-get.md): GET /api/v1/permissions: returns a list of Backend_PermissionDto.
- [List Products](/api-reference/operations/operation-api-v1-products-get.md): GET /api/v1/products: returns Backend_ProductListDto.
- [Create a Product](/api-reference/operations/operation-api-v1-products-post.md): POST /api/v1/products: takes Backend_CreateProductDto.
- [Get Product by ID](/api-reference/operations/operation-api-v1-products-product-id-get.md): GET /api/v1/products/{product_id}: returns Backend_ProductDto.
- [Delete a Product](/api-reference/operations/operation-api-v1-products-product-id-delete.md): DELETE /api/v1/products/{product_id}.
- [Update a Product](/api-reference/operations/operation-api-v1-products-product-id-patch.md): PATCH /api/v1/products/{product_id}: takes Backend_CreateProductDto.
- [Get Pricing List](/api-reference/operations/operation-api-v1-prices-get.md): GET /api/v1/prices: returns Backend_PricingListDto.
- [Create Pricing](/api-reference/operations/operation-api-v1-prices-post.md): POST /api/v1/prices: takes Backend_CreatePricingDto.
- [Update Pricing](/api-reference/operations/operation-api-v1-prices-price-id-patch.md): PATCH /api/v1/prices/{price_id}: takes Backend_UpdatePricingDto.
- [Get billing configuration](/api-reference/operations/operation-api-v1-billing-config-get.md): Returns the Stripe publishable key to the frontend.
- [List available plans](/api-reference/operations/operation-api-v1-billing-plans-get.md): GET /api/v1/billing/plans: returns Backend_PlanListDto.
- [Create a new plan](/api-reference/operations/operation-api-v1-billing-plans-post.md): POST /api/v1/billing/plans: takes Backend_CreatePlanDto.
- [Get a plan details](/api-reference/operations/operation-api-v1-billing-plans-plan-id-get.md): GET /api/v1/billing/plans/{plan_id}: returns Backend_PlanDto.
- [Delete existing plan](/api-reference/operations/operation-api-v1-billing-plans-plan-id-delete.md): DELETE /api/v1/billing/plans/{plan_id}.
- [Update a existing plan](/api-reference/operations/operation-api-v1-billing-plans-plan-id-patch.md): PATCH /api/v1/billing/plans/{plan_id}: takes Backend_UpdatePlanDto.
- [Create a Stripe SetupIntent for adding a payment method inline](/api-reference/operations/operation-api-v1-billing-payment-methods-setup-intent-post.md): Returns a Stripe SetupIntent client_secret. The frontend uses this with Stripe.js confirmCardSetup() to save a card without charging it.
- [List saved payment methods for the current tenant](/api-reference/operations/operation-api-v1-billing-payment-methods-get.md): GET /api/v1/billing/payment-methods: returns Backend_PaymentMethodListDto.
- [Remove a saved payment method](/api-reference/operations/operation-api-v1-billing-payment-methods-payment-method-id-delete.md): DELETE /api/v1/billing/payment-methods/{payment_method_id}.
- [Set a payment method as the default for the tenant](/api-reference/operations/operation-api-v1-billing-payment-methods-payment-method-id-default-post.md): POST /api/v1/billing/payment-methods/{payment_method_id}/default.
- [Sync tenant subscription with Stripe](/api-reference/operations/operation-api-v1-billing-sync-post.md): Sync tenant subscription with Stripe.
- [Create native subscription intent (compatibility endpoint)](/api-reference/operations/operation-api-v1-billing-subscription-create-intent-post.md): Create native subscription for tenant using Stripe Elements.
- [Create native subscription intent with Stripe Elements](/api-reference/operations/operation-api-v1-billing-native-subscription-post.md): Create native subscription for tenant using Stripe Elements.
- [Confirm native subscription (compatibility endpoint)](/api-reference/operations/operation-api-v1-billing-subscription-confirm-post.md): Confirm native subscription: update billing record and sync tenant subscription with Stripe.
- [Confirm native subscription and sync tenant data](/api-reference/operations/operation-api-v1-billing-native-subscription-confirm-post.md): Confirm native subscription: update billing record and sync tenant subscription with Stripe.
- [Create payment intent for incomplete subscription](/api-reference/operations/operation-api-v1-billing-subscription-complete-payment-post.md): Create a payment intent for an incomplete subscription so the user can complete payment.
- [Get current tenant subscription status](/api-reference/operations/operation-api-v1-billing-subscription-status-get.md): Returns the current tenant's subscription status including dormant state.
- [Downgrade dormant tenant to Free plan](/api-reference/operations/operation-api-v1-billing-subscription-downgrade-to-free-post.md): Downgrade a dormant/expired tenant to the Free plan. Cancels Stripe subscription but preserves all tenant data.
- [Stripe Webhook](/api-reference/operations/operation-api-v1-stripe-webhooks-post.md): POST /api/v1/stripe/webhooks.
- [List invoices](/api-reference/operations/operation-api-v1-invoices-get.md): GET /api/v1/invoices: returns Backend_InvoiceListDto.
- [List subscription history](/api-reference/operations/operation-api-v1-invoices-history-get.md): GET /api/v1/invoices/history: returns Backend_BillingRecordListDto.
- [List tenant invoices](/api-reference/operations/operation-api-v1-invoices-tenant-get.md): List invoices for the current tenant only, filtered by date range and status.
- [Export tenant invoices as CSV](/api-reference/operations/operation-api-v1-invoices-tenant-export-get.md): Export all tenant invoices as CSV for tax filing purposes.
- [Create Host Checkout Session](/api-reference/operations/operation-api-v1-checkouts-host-tenant-id-tenant-post.md): POST /api/v1/checkouts/host/{tenant_id}/tenant: takes Backend_CheckoutRequestDto, returns Backend_CheckoutResponseDto.
- [Create Tenant Subscription Checkout](/api-reference/operations/operation-api-v1-checkouts-tenant-subscription-post.md): Create a Stripe checkout session for tenant subscription. Uses host-level Stripe settings (NOT tenant-specific). Host charges tenants for their subscriptions.
- [Host Checkout Success](/api-reference/operations/operation-api-v1-checkouts-host-payment-success-post.md): POST /api/v1/checkouts/host/payment/success.
- [Host Checkout Canceled](/api-reference/operations/operation-api-v1-checkouts-host-payment-cancel-post.md): POST /api/v1/checkouts/host/payment/cancel.
- [Tenant Checkout Success](/api-reference/operations/operation-api-v1-checkouts-tenant-payment-success-post.md): Handle successful tenant subscription checkout. Uses host-level Stripe settings.
- [Tenant Checkout Canceled](/api-reference/operations/operation-api-v1-checkouts-tenant-payment-cancel-post.md): Handle cancelled tenant subscription checkout.
- [List Checkout Records](/api-reference/operations/operation-api-v1-checkouts-all-get.md): GET /api/v1/checkouts/all: returns Backend_BillingRecordListDto.
- [Get Notification Banner](/api-reference/operations/operation-api-v1-notifications-banner-get.md): Get the current notification banner information.
- [Create Notification Banner](/api-reference/operations/operation-api-v1-notifications-banner-post.md): Create a new notification banner setting.
- [Update Notification Banner](/api-reference/operations/operation-api-v1-notifications-banner-id-put.md): Update an existing notification banner setting.
- [List Audit Logs](/api-reference/operations/operation-api-v1-audit-logs-get.md): Also served by Audit Service at http://localhost:8013.
- [Ingest Audit Log](/api-reference/operations/operation-api-v1-audit-logs-post.md): Ingest a new audit log entry.
- [Download Audit Logs](/api-reference/operations/operation-api-v1-audit-logs-download-post.md): POST /api/v1/audit-logs/download: takes Backend_DownloadAuditRequestDto, returns Backend_DownloadResponseDto.
- [Get User Activity Logs](/api-reference/operations/operation-api-v1-users-user-id-activity-logs-get.md): GET /api/v1/users/{user_id}/activity-logs: returns Backend_AuditLogListDto.
- [Create Frontend Log](/api-reference/operations/operation-api-v1-frontend-logs-post.md): Receive frontend log entry and write to frontend/logs directory.
- [Health Check](/api-reference/operations/operation-api-v1-frontend-logs-health-get.md): Health check for frontend logging endpoint
- [Ingest Audit Event](/api-reference/operations/operation-api-v1-frontend-audit-logs-post.md): Relay a client-originated audit event to the centralized audit-service.
- [Get Deprecated Mobile Security Policy](/api-reference/operations/operation-api-v1-mobile-security-policies-tenant-id-get.md): DEPRECATED: Use GET /tenant-governance/{tenant_id} + GET /runtime-security-config/ instead.
- [Update Deprecated Mobile Security Policy](/api-reference/operations/operation-api-v1-mobile-security-policies-tenant-id-put.md): DEPRECATED: Use PUT /runtime-security-config/ + PUT /tenant-governance/{tenant_id} instead.
- [Get Runtime Security Config](/api-reference/operations/operation-api-v1-runtime-security-config-get.md): GET /api/v1/runtime-security-config: returns Backend_RuntimeSecurityConfigDto.
- [Update Runtime Security Config](/api-reference/operations/operation-api-v1-runtime-security-config-put.md): PUT /api/v1/runtime-security-config: takes Backend_UpdateRuntimeSecurityConfigDto, returns Backend_RuntimeSecurityConfigDto.
- [Get Tenant Governance](/api-reference/operations/operation-api-v1-tenant-governance-tenant-id-get.md): GET /api/v1/tenant-governance/{tenant_id}: returns Backend_TenantDataGovernanceDto.
- [Update Tenant Governance](/api-reference/operations/operation-api-v1-tenant-governance-tenant-id-put.md): PUT /api/v1/tenant-governance/{tenant_id}: takes Backend_UpdateTenantDataGovernanceDto, returns Backend_TenantDataGovernanceResponseDto.
- [Delete Tenant Governance](/api-reference/operations/operation-api-v1-tenant-governance-tenant-id-delete.md): DELETE /api/v1/tenant-governance/{tenant_id}: returns Backend_TenantDataGovernanceResponseDto.
- [Create Tenant Governance](/api-reference/operations/operation-api-v1-tenant-governance-post.md): POST /api/v1/tenant-governance: takes Backend_CreateTenantDataGovernanceDto, returns Backend_TenantDataGovernanceResponseDto.
- [Issue Remote Wipe](/api-reference/operations/operation-api-v1-tenant-governance-tenant-id-remote-wipe-post.md): POST /api/v1/tenant-governance/{tenant_id}/remote-wipe: takes Backend_RemoteWipeCommandDto.
- [Get App Version](/api-reference/operations/operation-api-v1-app-version-get.md): GET /api/v1/app/version: returns Backend_AppVersionCheckResponseDto.
- [List Tags](/api-reference/operations/operation-api-v1-surveys-tags-get.md): List all tags for the tenant.
- [Create Tag](/api-reference/operations/operation-api-v1-surveys-tags-post.md): Create a new tag.
- [Update Tag](/api-reference/operations/operation-api-v1-surveys-tags-tag-id-put.md): Update a tag.
- [Delete Tag](/api-reference/operations/operation-api-v1-surveys-tags-tag-id-delete.md): Delete a tag and remove all associations.
- [Get Survey Tags](/api-reference/operations/operation-api-v1-surveys-survey-id-tags-get.md): Get all tags assigned to a survey.
- [Assign Tags To Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-tags-post.md): Assign tags to a survey (replaces all existing tag assignments).
- [List Languages](/api-reference/operations/operation-api-v1-surveys-languages-get.md): List all languages for the tenant.
- [Create Language](/api-reference/operations/operation-api-v1-surveys-languages-post.md): Create a new language for the tenant.
- [Reorder Languages](/api-reference/operations/operation-api-v1-surveys-languages-reorder-put.md): Reorder languages by updating display_order based on array position.
- [Update Language](/api-reference/operations/operation-api-v1-surveys-languages-language-id-put.md): Update an existing language.
- [Delete Language](/api-reference/operations/operation-api-v1-surveys-languages-language-id-delete.md): Hard delete a language (remove from database).
- [Seed Default Languages](/api-reference/operations/operation-api-v1-surveys-languages-seed-post.md): Seed default languages for the tenant (if none exist).
- [Resolve lookup values](/api-reference/operations/operation-api-v1-surveys-lookups-survey-id-resolve-post.md): Resolve dependent field values based on a trigger question and value
- [Validate lookup value](/api-reference/operations/operation-api-v1-surveys-lookups-survey-id-validate-post.md): Validate that a lookup value exists in the lookup data
- [Get lookup configuration](/api-reference/operations/operation-api-v1-surveys-lookups-survey-id-config-get.md): Get structured lookup configuration for a survey
- [Get all lookup values](/api-reference/operations/operation-api-v1-surveys-lookups-survey-id-values-trigger-question-get.md): Get all valid values for a trigger question
- [Get lookup statistics](/api-reference/operations/operation-api-v1-surveys-lookups-survey-id-statistics-get.md): Get statistics about lookup data
- [Get available trigger values](/api-reference/operations/operation-api-v1-surveys-lookups-survey-id-available-triggers-get.md): Get trigger values with availability status for assignment UI
- [List Categories](/api-reference/operations/operation-api-v1-surveys-question-bank-categories-get.md): List question bank categories. Permission: template:read or template:manage
- [Create Category](/api-reference/operations/operation-api-v1-surveys-question-bank-categories-post.md): Create category. Permission: template:create or template:manage
- [Update Category](/api-reference/operations/operation-api-v1-surveys-question-bank-categories-category-id-put.md): Update category. Permission: template:update or template:manage
- [Delete Category](/api-reference/operations/operation-api-v1-surveys-question-bank-categories-category-id-delete.md): Delete category. Permission: template:delete or template:manage
- [List Questions](/api-reference/operations/operation-api-v1-surveys-question-bank-questions-get.md): List/search reusable questions. Permission: template:create or survey:create or template:manage or survey:manage
- [Create Question](/api-reference/operations/operation-api-v1-surveys-question-bank-questions-post.md): Create a reusable question. Permission: template:create or template:manage
- [Get Question](/api-reference/operations/operation-api-v1-surveys-question-bank-questions-question-id-get.md): Get question details. Permission: template:create or survey:create or template:manage or survey:manage
- [Update Question](/api-reference/operations/operation-api-v1-surveys-question-bank-questions-question-id-put.md): Update a reusable question. Permission: template:update or template:manage
- [Delete Question](/api-reference/operations/operation-api-v1-surveys-question-bank-questions-question-id-delete.md): Delete a reusable question. Permission: template:delete or template:manage
- [Import Questions](/api-reference/operations/operation-api-v1-surveys-question-bank-questions-import-post.md): Import multiple questions from a CSV file.
- [Add Question To Survey](/api-reference/operations/operation-api-v1-surveys-question-bank-add-to-survey-post.md): Add a bank question to a survey's schema. Permission: survey:create or survey:manage
- [List Surveys](/api-reference/operations/operation-api-v1-surveys-get.md): List surveys for the tenant.
- [Create Survey](/api-reference/operations/operation-api-v1-surveys-post.md): Create a new survey.
- [Get Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-get.md): Get a specific survey by ID.
- [Update Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-put.md): Update survey metadata (not the schema).
- [Delete Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-delete.md): Soft delete a survey (sets status to DELETED).
- [Update Survey Status](/api-reference/operations/operation-api-v1-surveys-survey-id-status-patch.md): Update survey status (DRAFT, PUBLISHED, ARCHIVED).
- [Duplicate Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-duplicate-post.md): Duplicate an existing survey including schema, settings, and lookups.
- [Update Survey Schedule](/api-reference/operations/operation-api-v1-surveys-survey-id-schedule-put.md): Update survey open/close schedule.
- [Get Survey Schema](/api-reference/operations/operation-api-v1-surveys-survey-id-schema-get.md): Get the survey design schema (form builder data).
- [Update Survey Schema](/api-reference/operations/operation-api-v1-surveys-survey-id-schema-put.md): Update the survey design schema (form builder data).
- [Get lookup data for auto-population](/api-reference/operations/operation-api-v1-surveys-survey-id-lookup-data-get.md): Returns lookup data for form auto-population. Used by form-service to cache lookup data.
- [Import Xlsform](/api-reference/operations/operation-api-v1-surveys-import-xlsform-post.md): Import a survey from an XLSForm Excel file (.xlsx).
- [Download a starter XLSForm template](/api-reference/operations/operation-api-v1-surveys-import-xlsform-download-get.md): Download a starter .xlsx XLSForm workbook that can be filled in and re-imported via POST /surveys/import-xlsform.
- [Validate a single expression](/api-reference/operations/operation-api-v1-surveys-expressions-validate-post.md): Validate a skip logic, constraint, or calculation expression against available fields.
- [List Survey Media](/api-reference/operations/operation-api-v1-surveys-survey-id-media-get.md): List all media assets for a survey.
- [Upload Survey Media](/api-reference/operations/operation-api-v1-surveys-survey-id-media-post.md): Upload media assets (images, videos, audio) for survey questions.
- [List Versions](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-get.md): List all versions of a survey.
- [Create New Version](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-post.md): Create a new draft version of a survey.
- [Get Version](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-version-id-get.md): Get a specific version of a survey.
- [Update Version Schema](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-version-id-put.md): Update schema for a draft version.
- [Discard Version](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-version-id-delete.md): Discard a draft version.
- [Clone Version To New Draft](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-version-id-clone-post.md): Clone an existing version to a new draft.
- [Get Latest Version](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-latest-get.md): Get the latest version of a survey.
- [Fetch the content-addressed schema artifact for a version](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-version-id-schema-artifact-get.md): Returns the governing schema artifact for a survey version: canonical_schema is the exact string whose UTF-8 bytes hash to schema_sha256. Unlike the render endpoints this performs no media-audio enrichment, so the served bytes and the declared digest always agree. A client verifies by hashing canonical_schema and…
- [Export survey version as XLSForm](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-version-id-export-xlsform-get.md): Download a survey version as an XLSForm .xlsx file with optional language selection.
- [Publish Check](/api-reference/operations/operation-api-v1-surveys-survey-id-publish-check-get.md): Check whether publishing a new version of this survey is safe.
- [Publish Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-publish-post.md): Publish a survey.
- [Unpublish Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-unpublish-post.md): Unpublish a survey (set back to draft).
- [Archive Survey](/api-reference/operations/operation-api-v1-surveys-survey-id-archive-post.md): Archive a survey permanently.
- [Get Published Version](/api-reference/operations/operation-api-v1-surveys-survey-id-published-get.md): Get the currently published version of a survey.
- [List Published Versions](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-published-get.md): List all published versions of a survey (for audit trail).
- [Archive Version](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-version-id-archive-post.md): Archive a published version.
- [Get Survey Version](/api-reference/operations/operation-api-v1-surveys-survey-id-version-version-id-get.md): Get a specific version of a survey by ID.
- [List Form Access](/api-reference/operations/operation-api-v1-surveys-survey-id-access-get.md): List all users who have access to a specific survey form.
- [Grant Form Access](/api-reference/operations/operation-api-v1-surveys-survey-id-access-post.md): Grant a user access to fill a specific survey form.
- [Bulk Grant Form Access](/api-reference/operations/operation-api-v1-surveys-survey-id-access-bulk-post.md): Grant multiple users access to fill a specific survey form.
- [List User Form Access](/api-reference/operations/operation-api-v1-surveys-users-user-id-access-get.md): List all surveys a specific user currently has access to within the authenticated tenant.
- [Revoke Form Access](/api-reference/operations/operation-api-v1-surveys-survey-id-access-target-user-id-delete.md): Revoke a user's access to a specific survey form as an auditable soft-delete tombstone (R17).
- [Update Form Access](/api-reference/operations/operation-api-v1-surveys-survey-id-access-target-user-id-patch.md): Update a user's access level or expiry for a specific survey form.
- [Check Form Access](/api-reference/operations/operation-api-v1-surveys-survey-id-access-check-get.md): Check if the current user has access to a specific survey form.
- [Check Historical Form Access](/api-reference/operations/operation-api-v1-surveys-survey-id-access-historical-get.md): Check if a user was authorized to collect/fill a survey at a specific historical point in time (R17 & R22).
- [Get My Accessible Surveys](/api-reference/operations/operation-api-v1-surveys-access-my-get.md): Get all surveys that the current user has access to.
- [Get Enumerators For Supervisor](/api-reference/operations/operation-api-v1-surveys-access-enumerators-get.md): Get all enumerator user IDs that were granted access by the current Field Supervisor.
- [Relay Production Activity](/api-reference/operations/operation-api-v1-surveys-survey-id-production-activity-post.md): Mark that production collection has begun for a survey's project (internal).
- [Issue Grant](/api-reference/operations/operation-api-v1-surveys-survey-id-collection-grants-post.md): Issue a durable collection grant (internal, service-auth only).
- [Validate Grant](/api-reference/operations/operation-api-v1-surveys-survey-id-collection-grants-validate-get.md): Authoritatively validate a submission's collection provenance (internal).
- [Mark Late Arrival](/api-reference/operations/operation-api-v1-surveys-collection-grants-grant-id-late-arrival-post.md): Flag a grant whose data landed after project closure (internal).
- [Get Survey Name](/api-reference/operations/operation-api-v1-surveys-internal-name-survey-id-get.md): Return the display name for an internal survey_id (service-auth only).
- [List Template Categories](/api-reference/operations/operation-api-v1-template-categories-get.md): List all template categories for the tenant.
- [Create Template Category](/api-reference/operations/operation-api-v1-template-categories-post.md): Create a new template category.
- [Get Template Category](/api-reference/operations/operation-api-v1-template-categories-category-id-get.md): Get a specific template category by ID.
- [Update Template Category](/api-reference/operations/operation-api-v1-template-categories-category-id-put.md): Update a template category.
- [Delete Template Category](/api-reference/operations/operation-api-v1-template-categories-category-id-delete.md): Delete a template category.
- [List Templates](/api-reference/operations/operation-api-v1-templates-get.md): List all survey templates accessible for the tenant.
- [Create Template](/api-reference/operations/operation-api-v1-templates-post.md): Create a new survey template.
- [List Templates Grouped](/api-reference/operations/operation-api-v1-templates-by-category-get.md): List all survey templates grouped by category.
- [Get Template](/api-reference/operations/operation-api-v1-templates-template-id-get.md): Get a specific survey template by ID.
- [Update Template](/api-reference/operations/operation-api-v1-templates-template-id-put.md): Update a survey template.
- [Delete Template](/api-reference/operations/operation-api-v1-templates-template-id-delete.md): Delete a survey template.
- [Import Template From Xlsform](/api-reference/operations/operation-api-v1-templates-import-xlsform-post.md): Import a survey template from an XLSForm Excel file (.xlsx).
- [Download a starter XLSForm template](/api-reference/operations/operation-api-v1-templates-import-xlsform-download-get.md): Download a starter .xlsx XLSForm workbook that can be filled in and re-imported via POST /templates/import-xlsform.
- [Create Survey From Template](/api-reference/operations/operation-api-v1-templates-create-survey-post.md): Create a new survey using a template's schema.
- [Seed Default Templates](/api-reference/operations/operation-api-v1-templates-seed-post.md): Seed default template categories and templates if none exist.
- [Upload XLSForm as New Survey Version](/api-reference/operations/operation-api-v1-surveys-survey-id-versions-upload-post.md): Create a new version of an existing survey by uploading an XLSForm file.
- [Download blank form as PDF](/api-reference/operations/operation-api-v1-surveys-survey-id-blank-pdf-get.md): Generate and download a blank paper form PDF for a published survey.
- [Metrics](/api-reference/operations/operation-api-v1-metrics-get.md): Prometheus metrics endpoint
- [Check Survey Schedules](/api-reference/operations/operation-api-v1-surveys-check-schedules-post.md): Manually trigger survey schedule check for the tenant.
- [Run Migrations](/api-reference/operations/operation-api-v1-migrations-run-post.md): Run database migrations for tenant
- [Ingest Bulk Responses](/api-reference/operations/operation-api-v1-responses-bulk-post.md): Ingest multiple survey responses in bulk.
- [Bulk Delete Responses](/api-reference/operations/operation-api-v1-responses-bulk-delete-post.md): Bulk delete survey responses.
- [Bulk Invalidate Responses](/api-reference/operations/operation-api-v1-responses-bulk-invalidate-post.md): Bulk invalidate survey responses with a reason.
- [Bulk Approve Responses](/api-reference/operations/operation-api-v1-responses-bulk-approve-post.md): Bulk approve survey responses.
- [Bulk Update Status Responses](/api-reference/operations/operation-api-v1-responses-bulk-update-status-post.md): Bulk update status of survey responses.
- [Search Similar](/api-reference/operations/operation-api-v1-responses-search-similar-post.md): Find similar responses by survey_id + identifier fields
- [Get Duplicate Groups](/api-reference/operations/operation-api-v1-responses-duplicate-groups-get.md): List all duplicate groups (paginated, filterable)
- [Merge](/api-reference/operations/operation-api-v1-responses-response-id-merge-post.md): Merge response into another response
- [Update Group Status](/api-reference/operations/operation-api-v1-responses-duplicate-groups-group-id-status-post.md): Update the status of a duplicate group
- [List Responses](/api-reference/operations/operation-api-v1-responses-get.md): List survey responses with filtering and pagination.
- [Submit Response](/api-reference/operations/operation-api-v1-responses-post.md): Submit a survey response.
- [Get RID sequential counter](/api-reference/operations/operation-api-v1-responses-response-counters-get.md): Get the current sequential RID counter for a user + survey. Returns 0 when no RID has been generated yet. Clients increment the returned value locally to build the next RID.
- [Get latest response by respondent ID](/api-reference/operations/operation-api-v1-responses-by-respondent-id-survey-id-get.md): Get the latest submitted/completed response for a respondent in a survey.
- [Get response by unique ID](/api-reference/operations/operation-api-v1-responses-by-unique-id-survey-id-get.md): Get a response matching the unique_id (uid) value for a survey.
- [Get enumerator statistics for a survey](/api-reference/operations/operation-api-v1-responses-enumerator-stats-get.md): Get per-enumerator submission counts, rejection rates, and quality metrics.
- [List Response Changes](/api-reference/operations/operation-api-v1-responses-changes-get.md): Durable, resumable feed of this enumerator's own response changes (E1b).
- [Get Response](/api-reference/operations/operation-api-v1-responses-response-id-get.md): Get a single response by ID with optional answer details.
- [Update Response](/api-reference/operations/operation-api-v1-responses-response-id-put.md): Update response metadata (only allowed for draft/submitted responses).
- [Delete Response](/api-reference/operations/operation-api-v1-responses-response-id-delete.md): Delete a response and all its answers.
- [Invalidate Response](/api-reference/operations/operation-api-v1-responses-response-id-invalidate-post.md): Mark a response as invalidated with optional error messages.
- [Edit Response](/api-reference/operations/operation-api-v1-responses-response-id-edit-patch.md): Edit a submitted/completed response. Maintains full audit trail.
- [Get Response Edits](/api-reference/operations/operation-api-v1-responses-response-id-edits-get.md): Get edit history for a specific response.
- [Submit Response For Approval](/api-reference/operations/operation-api-v1-responses-response-id-submit-for-approval-post.md): Submit a response for approval.
- [Approve Response](/api-reference/operations/operation-api-v1-responses-response-id-approve-post.md): Approve a response that is pending approval.
- [Reject Response](/api-reference/operations/operation-api-v1-responses-response-id-reject-post.md): Reject a response that is pending approval.
- [Correct Response](/api-reference/operations/operation-api-v1-responses-response-id-correct-post.md): Correct a rejected response and resubmit it for approval (E1a).
- [Complete Response](/api-reference/operations/operation-api-v1-responses-response-id-complete-post.md): Mark a response as completed.
- [Get Pending Approval Count](/api-reference/operations/operation-api-v1-responses-pending-approval-count-get.md): Get count of responses pending approval for a given survey.
- [Update Review Flags](/api-reference/operations/operation-api-v1-responses-response-id-review-flags-put.md): Update review flags for a response pending approval.
- [Get response statistics for a survey (internal)](/api-reference/operations/operation-api-v1-responses-survey-stats-survey-id-get.md): Return response counts grouped by status for a given survey. Used internally by survey-service for publish guardrails. Requires X-Tenant-ID header for multi-tenant routing.
- [Validate a list of response IDs (removes orphans)](/api-reference/operations/operation-api-v1-responses-survey-id-validate-ids-post.md): Takes a list of response UUIDs and returns only those that exist and belong to the current survey/tenant. Used to identify orphaned media attachments.
- [Export Responses](/api-reference/operations/operation-api-v1-export-responses-post.md): Export survey responses in CSV, Excel, or JSON format. Returns a streaming response with the exported data.
- [Export Responses Stream](/api-reference/operations/operation-api-v1-export-responses-stream-get.md): Stream export responses (GET version for simple downloads).
- [Get Media Export Status](/api-reference/operations/operation-api-v1-export-media-request-id-status-get.md): Poll the status of a background media export job.
- [Export Survey Csv](/api-reference/operations/operation-api-v1-export-survey-survey-id-csv-get.md): Quick CSV export for a survey.
- [Export Survey Json](/api-reference/operations/operation-api-v1-export-survey-survey-id-json-get.md): Quick JSON export for a survey.
- [Export Survey Xlsx](/api-reference/operations/operation-api-v1-export-survey-survey-id-xlsx-get.md): Quick Excel export for a survey.
- [Export Survey Stata](/api-reference/operations/operation-api-v1-export-survey-survey-id-dta-get.md): Quick STATA export for a survey.
- [Export Survey Spss](/api-reference/operations/operation-api-v1-export-survey-survey-id-sav-get.md): Quick SPSS export for a survey.
- [List Attachments](/api-reference/operations/operation-api-v1-attachments-get.md): List attachments with filtering.
- [Upload Attachment](/api-reference/operations/operation-api-v1-attachments-post.md): Upload a file attachment.
- [Create Attachment Record](/api-reference/operations/operation-api-v1-attachments-record-post.md): Create an attachment record from provided metadata (file already uploaded via media-service).
- [Get Attachment](/api-reference/operations/operation-api-v1-attachments-attachment-id-get.md): Get attachment metadata by ID.
- [Delete Attachment](/api-reference/operations/operation-api-v1-attachments-attachment-id-delete.md): Delete an attachment.
- [Update Attachment](/api-reference/operations/operation-api-v1-attachments-attachment-id-patch.md): Update attachment metadata (notes/description and field_name).
- [Download Attachment](/api-reference/operations/operation-api-v1-attachments-attachment-id-download-get.md): Download attachment file.
- [Get Active Surveys](/api-reference/operations/operation-api-v1-analytics-responses-active-get.md): Get a list of all survey IDs for this tenant that have at least one response. Used by frontend to filter survey list in Data Viewer.
- [Get Response Stats](/api-reference/operations/operation-api-v1-analytics-responses-stats-survey-id-get.md): Get comprehensive statistics for survey responses.
- [Get Response Timeseries](/api-reference/operations/operation-api-v1-analytics-responses-timeseries-survey-id-get.md): Get time-series data for survey responses.
- [Get Question Stats](/api-reference/operations/operation-api-v1-analytics-responses-questions-survey-id-get.md): Get statistics for individual questions across all responses.
- [Get Answer Distribution](/api-reference/operations/operation-api-v1-analytics-responses-distribution-survey-id-question-id-get.md): Get distribution of answers for a specific question.
- [Get Analytics Summary](/api-reference/operations/operation-api-v1-analytics-responses-summary-survey-id-get.md): Get a comprehensive analytics summary for a survey.
- [Get Dashboard Metrics](/api-reference/operations/operation-api-v1-analytics-dashboard-get.md): Get consolidated dashboard metrics for the Operations Center.
- [Get Dashboard Data](/api-reference/operations/operation-api-v1-analytics-dashboard-survey-id-get.md): Get all analytics data for a dashboard view.
- [Generate Random Sample](/api-reference/operations/operation-api-v1-sampling-generate-post.md): Generate a random sample from an uploaded CSV or Excel file.
- [Generate Random Sample](/api-reference/operations/operation-api-v1-data-sampling-generate-post.md): Generate a random sample from an uploaded CSV or Excel file.
- [Health Check](/api-reference/operations/operation-api-v1-sync-health-get.md): Health check endpoint.
- [List User Devices](/api-reference/operations/operation-api-v1-sync-devices-get.md): List all devices registered for the current user.
- [Register Device](/api-reference/operations/operation-api-v1-sync-devices-post.md): Register a new device for the current user.
- [Get Device](/api-reference/operations/operation-api-v1-sync-devices-device-id-get.md): Get device details by device ID.
- [Update Device](/api-reference/operations/operation-api-v1-sync-devices-device-id-put.md): Update device information.
- [Deregister Device](/api-reference/operations/operation-api-v1-sync-devices-device-id-delete.md): Deregister a device.
- [Update Push Token](/api-reference/operations/operation-api-v1-sync-devices-device-id-push-token-patch.md): Update device push token.
- [Set Primary Device](/api-reference/operations/operation-api-v1-sync-devices-device-id-set-primary-post.md): Set device as primary for the user.
- [Pull Sync](/api-reference/operations/operation-api-v1-sync-pull-post.md): Pull synchronized data from the server.
- [Acknowledge Form Download](/api-reference/operations/operation-api-v1-sync-downloads-acknowledge-post.md): Record a form download after the mobile client persisted its schema.
- [Get Sync Status](/api-reference/operations/operation-api-v1-sync-status-get.md): Get sync status for all devices of the current user.
- [Get Device Sync Status](/api-reference/operations/operation-api-v1-sync-status-device-id-get.md): Get sync status for a specific device.
- [Initialize Sync](/api-reference/operations/operation-api-v1-sync-initialize-post.md): Initialize sync for a new device.
- [Delete Device Sync](/api-reference/operations/operation-api-v1-sync-device-device-id-delete.md): Delete sync record for a device.
- [Push Single Response](/api-reference/operations/operation-api-v1-sync-push-post.md): Push a single survey response to the server.
- [Push Bulk Responses](/api-reference/operations/operation-api-v1-sync-push-bulk-post.md): Push multiple survey responses in a batch.
- [Get Push Status](/api-reference/operations/operation-api-v1-sync-push-status-push-id-get.md): Get status of a push operation.
- [Get Pending Pushes](/api-reference/operations/operation-api-v1-sync-push-pending-get.md): Get all pending/failed push operations for retry.
- [Get Failed Submissions Today](/api-reference/operations/operation-api-v1-sync-dashboard-failed-submissions-get.md): Get count of failed submission attempts today.
- [List Unresolved Conflicts](/api-reference/operations/operation-api-v1-sync-conflicts-get.md): Get all unresolved sync conflicts for the tenant.
- [Get Conflict](/api-reference/operations/operation-api-v1-sync-conflicts-conflict-id-get.md): Get a specific conflict by ID.
- [Resolve Conflict](/api-reference/operations/operation-api-v1-sync-conflicts-conflict-id-resolve-post.md): Resolve a sync conflict using a specified strategy (server_wins, client_wins).
- [List Response Changes](/api-reference/operations/operation-api-v1-sync-responses-changes-get.md): Discover response status/answer-schema changes since a client-held cursor.
- [Correct Response](/api-reference/operations/operation-api-v1-sync-responses-response-id-correct-post.md): Resubmit a corrected (previously rejected) response against its existing ID.
- [Reconcile Revoked Work](/api-reference/operations/operation-api-v1-sync-reconcile-post.md): Server-Authorized Reconciliation Endpoint (R17 & R22).
- [Get Dashboard Summary](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-summary-get.md): Get dashboard summary metrics for the tenant.
- [Get Survey Performance](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-surveys-performance-get.md): Get survey performance metrics.
- [Get Response Metrics](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-responses-metrics-get.md): Get response metrics over time.
- [Invalidate Dashboard Cache](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-invalidate-cache-post.md): Invalidate all dashboard cache for the tenant.
- [List Dashboards](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-get.md): List all dashboards for the tenant.
- [Create Dashboard](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-post.md): Create a new dashboard.
- [Get Dashboard](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-dashboard-id-get.md): Get a dashboard by ID with its widgets.
- [Update Dashboard](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-dashboard-id-put.md): Update a dashboard.
- [Delete Dashboard](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-dashboard-id-delete.md): Delete a dashboard and all its widgets.
- [Create Widget](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-dashboard-id-widgets-post.md): Add a widget to a dashboard.
- [Update Widget](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-dashboard-id-widgets-widget-id-put.md): Update a widget.
- [Delete Widget](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-dashboard-id-widgets-widget-id-delete.md): Delete a widget.
- [Get Widget Data](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-dashboard-id-widgets-widget-id-data-get.md): Get data for a widget.
- [Generate Default Dashboard](/api-reference/operations/operation-api-v1-analytics-custom-dashboards-generate-post.md): Generate or regenerate a default dashboard for a published survey.
- [Get Survey Analytics](/api-reference/operations/operation-api-v1-analytics-surveys-survey-id-get.md): Get analytics for a specific survey.
- [Get Analytics Summary](/api-reference/operations/operation-api-v1-analytics-summary-get.md): Get overall analytics summary for the tenant.
- [Get Survey Responses](/api-reference/operations/operation-api-v1-analytics-surveys-survey-id-responses-get.md): Get paginated responses for a survey.
- [Get Survey Questions Analytics](/api-reference/operations/operation-api-v1-analytics-surveys-survey-id-questions-get.md): Get analytics per question for a survey.
- [Export Survey Analytics](/api-reference/operations/operation-api-v1-analytics-export-survey-id-get.md): Export survey analytics in the specified format.
- [Aggregate Survey Data](/api-reference/operations/operation-api-v1-analytics-aggregate-post.md): Aggregate survey response data for chart visualisation.
- [List Workspaces](/api-reference/operations/operation-api-v1-workspaces-get.md): GET /api/v1/workspaces: returns WorkspaceService_WorkspaceListDTO.
- [Create Workspace](/api-reference/operations/operation-api-v1-workspaces-post.md): POST /api/v1/workspaces: takes WorkspaceService_WorkspaceCreateDTO, returns WorkspaceService_WorkspaceResponseDTO.
- [Get Workspace](/api-reference/operations/operation-api-v1-workspaces-workspace-id-get.md): GET /api/v1/workspaces/{workspace_id}: returns WorkspaceService_WorkspaceResponseDTO.
- [Update Workspace](/api-reference/operations/operation-api-v1-workspaces-workspace-id-put.md): PUT /api/v1/workspaces/{workspace_id}: takes WorkspaceService_WorkspaceUpdateDTO, returns WorkspaceService_WorkspaceResponseDTO.
- [Delete Workspace](/api-reference/operations/operation-api-v1-workspaces-workspace-id-delete.md): DELETE /api/v1/workspaces/{workspace_id}.
- [List Members](/api-reference/operations/operation-api-v1-workspaces-workspace-id-members-get.md): GET /api/v1/workspaces/{workspace_id}/members: returns WorkspaceService_MemberListDTO.
- [Add Member](/api-reference/operations/operation-api-v1-workspaces-workspace-id-members-post.md): POST /api/v1/workspaces/{workspace_id}/members: takes WorkspaceService_MemberAddDTO, returns WorkspaceService_MemberResponseDTO.
- [Update Member Role](/api-reference/operations/operation-api-v1-workspaces-workspace-id-members-member-user-id-put.md): PUT /api/v1/workspaces/{workspace_id}/members/{member_user_id}: takes WorkspaceService_MemberUpdateDTO, returns WorkspaceService_MemberResponseDTO.
- [Remove Member](/api-reference/operations/operation-api-v1-workspaces-workspace-id-members-member-user-id-delete.md): DELETE /api/v1/workspaces/{workspace_id}/members/{member_user_id}.
- [Get Member Usage](/api-reference/operations/operation-api-v1-workspaces-members-usage-get.md): Return the tenant-scoped usage snapshot for the enforced member entitlement.
- [List Projects](/api-reference/operations/operation-api-v1-workspaces-workspace-id-projects-get.md): GET /api/v1/workspaces/{workspace_id}/projects: returns WorkspaceService_ProjectListDTO.
- [Create Project](/api-reference/operations/operation-api-v1-workspaces-workspace-id-projects-post.md): POST /api/v1/workspaces/{workspace_id}/projects: takes WorkspaceService_ProjectCreateDTO, returns WorkspaceService_ProjectResponseDTO.
- [Get Project By Workspace](/api-reference/operations/operation-api-v1-workspaces-workspace-id-projects-project-id-get.md): GET /api/v1/workspaces/{workspace_id}/projects/{project_id}: returns WorkspaceService_ProjectResponseDTO.
- [Update Project By Workspace](/api-reference/operations/operation-api-v1-workspaces-workspace-id-projects-project-id-put.md): PUT /api/v1/workspaces/{workspace_id}/projects/{project_id}: takes WorkspaceService_ProjectUpdateDTO, returns WorkspaceService_ProjectResponseDTO.
- [Delete Project By Workspace](/api-reference/operations/operation-api-v1-workspaces-workspace-id-projects-project-id-delete.md): DELETE /api/v1/workspaces/{workspace_id}/projects/{project_id}.
- [Get Project Lifecycle](/api-reference/operations/operation-api-v1-workspaces-workspace-id-projects-project-id-lifecycle-get.md): Read the lifecycle state of a project (internal).
- [Mark Production Activity](/api-reference/operations/operation-api-v1-workspaces-workspace-id-projects-project-id-production-activity-post.md): Mark that production collection has begun for a project (internal).
- [List Subscriptions](/api-reference/operations/operation-api-v1-webhooks-subscriptions-get.md): List all webhook subscriptions for the tenant.
- [Create Subscription](/api-reference/operations/operation-api-v1-webhooks-subscriptions-post.md): Create a new webhook subscription.
- [Get Subscription](/api-reference/operations/operation-api-v1-webhooks-subscriptions-subscription-id-get.md): Get a specific webhook subscription.
- [Update Subscription](/api-reference/operations/operation-api-v1-webhooks-subscriptions-subscription-id-put.md): Update a webhook subscription.
- [Delete Subscription](/api-reference/operations/operation-api-v1-webhooks-subscriptions-subscription-id-delete.md): Delete a webhook subscription.
- [Toggle Subscription](/api-reference/operations/operation-api-v1-webhooks-subscriptions-subscription-id-toggle-post.md): Toggle subscription active status.
- [Rotate Secret](/api-reference/operations/operation-api-v1-webhooks-subscriptions-subscription-id-rotate-secret-post.md): Rotate the secret for a webhook subscription.
- [Test Webhook](/api-reference/operations/operation-api-v1-webhooks-subscriptions-subscription-id-test-post.md): Trigger a test event for a specific webhook subscription.
- [List Deliveries](/api-reference/operations/operation-api-v1-webhooks-deliveries-get.md): List webhook deliveries for the tenant.
- [Get Delivery](/api-reference/operations/operation-api-v1-webhooks-deliveries-delivery-id-get.md): Get details of a specific webhook delivery.
- [Retry Delivery](/api-reference/operations/operation-api-v1-webhooks-deliveries-delivery-id-retry-post.md): Manually retry a failed webhook delivery.
- [Get Delivery Stats](/api-reference/operations/operation-api-v1-webhooks-deliveries-stats-overview-get.md): Get delivery statistics for the tenant.
- [Health Check](/api-reference/operations/operation-health-get.md): Health check endpoint.
- [List Forms](/api-reference/operations/operation-formlist-get.md): OpenRosa Form List API Returns XML list of available forms for the device/user
- [Download Form](/api-reference/operations/operation-download-form-id-get.md): Download XForm definition (XML) Converts internal survey schema to ODK XForm format
- [Submit Form](/api-reference/operations/operation-submission-post.md): OpenRosa Form Submission API Accepts XML submission with optional media attachments
- [Pull From Central](/api-reference/operations/operation-pull-from-central-post.md): Trigger a pull of new submissions from ODK Central.
- [Readiness Check](/api-reference/operations/operation-api-v1-health-ready-get.md): Readiness check for Kubernetes/container orchestration.
- [Liveness Check](/api-reference/operations/operation-api-v1-health-live-get.md): Liveness check for Kubernetes/container orchestration.
- [Render form for filling](/api-reference/operations/operation-api-v1-forms-survey-id-render-get.md): Render a survey form for user to fill. Creates a new session or continues an existing interview session.
- [Get pre-fill data from previous response](/api-reference/operations/operation-api-v1-forms-survey-id-prefill-get.md): Fetch pre-fill data from a previous response by respondent_id or unique_id.
- [Preview form without session](/api-reference/operations/operation-api-v1-forms-survey-id-preview-get.md): Preview a form schema without creating a session.
- [Get offline manifest](/api-reference/operations/operation-api-v1-forms-survey-id-manifest-get.md): Get manifest for offline form support (service worker).
- [Submit completed form](/api-reference/operations/operation-api-v1-forms-submit-post.md): Submit a completed form response.
- [Submit offline form](/api-reference/operations/operation-api-v1-forms-submit-offline-post.md): Submit a form that was filled offline.
- [Validate form data](/api-reference/operations/operation-api-v1-forms-validate-post.md): Validate form data without submitting.
- [List user's drafts](/api-reference/operations/operation-api-v1-forms-drafts-get.md): List all drafts for the current user.
- [Create draft](/api-reference/operations/operation-api-v1-forms-drafts-post.md): Create a new draft with sync and idempotency support.
- [Delta sync drafts](/api-reference/operations/operation-api-v1-forms-drafts-delta-get.md): Pull drafts updated since a given cursor timestamp or keyset cursor, including tombstones (Wave 9 / R24).
- [List all drafts (admin)](/api-reference/operations/operation-api-v1-forms-drafts-all-get.md): List all drafts across users (admin only).
- [Get draft](/api-reference/operations/operation-api-v1-forms-drafts-draft-id-get.md): Get a specific draft by ID.
- [Update draft](/api-reference/operations/operation-api-v1-forms-drafts-draft-id-put.md): Update an existing draft with optimistic concurrency checks.
- [Delete draft](/api-reference/operations/operation-api-v1-forms-drafts-draft-id-delete.md): Soft-delete a draft with tombstone so stale devices do not resurrect it.
- [Drain and archive offline draft after authorization revocation](/api-reference/operations/operation-api-v1-forms-drafts-drain-revoked-post.md): Validates pre-revocation editing timestamps against historical authorization, setting status to 'archived_revoked'.
- [List user's sessions](/api-reference/operations/operation-api-v1-forms-sessions-get.md): List all form sessions for the current user.
- [List all sessions (admin)](/api-reference/operations/operation-api-v1-forms-sessions-all-get.md): List all form sessions across users (admin only).
- [Get session](/api-reference/operations/operation-api-v1-forms-sessions-session-id-get.md): Get a specific session by ID.
- [Delete session](/api-reference/operations/operation-api-v1-forms-sessions-session-id-delete.md): Delete/invalidate a session.
- [Get session by token](/api-reference/operations/operation-api-v1-forms-sessions-token-session-token-get.md): Get a session by its token.
- [Resolve lookup values](/api-reference/operations/operation-api-v1-forms-session-token-lookup-get.md): Resolve referee question values from lookup data based on trigger question answer.
- [Validate single field constraint](/api-reference/operations/operation-api-v1-validation-field-post.md): Validate a single field against its XPath constraint
- [Validate entire form](/api-reference/operations/operation-api-v1-validation-form-post.md): Validate all field constraints in a form
- [Evaluate XPath expression](/api-reference/operations/operation-api-v1-validation-evaluate-post.md): Evaluate an XPath expression with form data context
- [List available XPath functions](/api-reference/operations/operation-api-v1-validation-functions-get.md): Get list of all available XPath/ODK functions
- [Test constraint expression](/api-reference/operations/operation-api-v1-validation-test-constraint-post.md): Test a constraint expression with sample data
- [List RID block allocations](/api-reference/operations/operation-api-v1-interviews-rid-blocks-get.md): List RID block allocations for the tenant. Field users see their own blocks.
- [Allocate server-issued device-bound RID block](/api-reference/operations/operation-api-v1-interviews-rid-blocks-post.md): Allocate a non-overlapping block of RIDs bound to (tenant, survey, user, device) (R25 / AD-3).
- [List interviews](/api-reference/operations/operation-api-v1-interviews-get.md): GET /api/v1/interviews: returns FormService_InterviewListResponse.
- [Create interview](/api-reference/operations/operation-api-v1-interviews-post.md): POST /api/v1/interviews: takes FormService_CreateInterviewDto, returns FormService_InterviewDto.
- [Resolve interview by session token](/api-reference/operations/operation-api-v1-interviews-resolve-by-session-token-session-token-get.md): GET /api/v1/interviews/resolve/by-session-token/{session_token}: returns FormService_InterviewDto.
- [Get interview details](/api-reference/operations/operation-api-v1-interviews-interview-id-get.md): GET /api/v1/interviews/{interview_id}: returns FormService_InterviewDto.
- [Soft-delete interview (only if status is created)](/api-reference/operations/operation-api-v1-interviews-interview-id-delete.md): DELETE /api/v1/interviews/{interview_id}.
- [Update interview metadata](/api-reference/operations/operation-api-v1-interviews-interview-id-patch.md): PATCH /api/v1/interviews/{interview_id}: takes FormService_UpdateInterviewDto, returns FormService_InterviewDto.
- [Transition interview status](/api-reference/operations/operation-api-v1-interviews-interview-id-transition-post.md): POST /api/v1/interviews/{interview_id}/transition: takes FormService_TransitionInterviewDto, returns FormService_InterviewDto.
- [Get termination details for an interview](/api-reference/operations/operation-api-v1-interviews-interview-id-termination-get.md): GET /api/v1/interviews/{interview_id}/termination: returns FormService_TerminationDto.
- [List all termination reason options with policies](/api-reference/operations/operation-api-v1-interviews-termination-policies-get.md): GET /api/v1/interviews/termination-policies: returns a list of FormService_TerminationReasonOptionDto.
- [Retry pending partial submission for terminated interview](/api-reference/operations/operation-api-v1-interviews-interview-id-retry-submission-post.md): Retry a pending partial submission for a terminated interview.
- [Heartbeat ping for active interview](/api-reference/operations/operation-api-v1-interviews-interview-id-heartbeat-post.md): POST /api/v1/interviews/{interview_id}/heartbeat.
- [List interview events](/api-reference/operations/operation-api-v1-interviews-interview-id-events-get.md): GET /api/v1/interviews/{interview_id}/events: returns a list of FormService_InterviewEventDto.
- [List notes for an interview](/api-reference/operations/operation-api-v1-interviews-interview-id-notes-get.md): GET /api/v1/interviews/{interview_id}/notes: returns FormService_NoteListResponse.
- [Create a note for an interview](/api-reference/operations/operation-api-v1-interviews-interview-id-notes-post.md): POST /api/v1/interviews/{interview_id}/notes: takes FormService_NoteCreateDto, returns FormService_NoteResponseDto.
- [Get a specific note](/api-reference/operations/operation-api-v1-interviews-interview-id-notes-note-id-get.md): GET /api/v1/interviews/{interview_id}/notes/{note_id}: returns FormService_NoteResponseDto.
- [Update a note](/api-reference/operations/operation-api-v1-interviews-interview-id-notes-note-id-put.md): PUT /api/v1/interviews/{interview_id}/notes/{note_id}: takes FormService_NoteUpdateDto, returns FormService_NoteResponseDto.
- [Delete a note](/api-reference/operations/operation-api-v1-interviews-interview-id-notes-note-id-delete.md): DELETE /api/v1/interviews/{interview_id}/notes/{note_id}.
- [Batch create notes](/api-reference/operations/operation-api-v1-interviews-interview-id-notes-batch-post.md): POST /api/v1/interviews/{interview_id}/notes/batch: takes FormService_BatchNoteCreateDto, returns a list of FormService_NoteResponseDto.
- [Get Migration Version](/api-reference/operations/operation-api-v1-migrations-version-get.md): Get current Alembic migration version for specific tenant.
- [Run Cleanup](/api-reference/operations/operation-api-v1-cleanup-run-post.md): Run cleanup job to remove expired sessions and drafts.
- [Upload File](/api-reference/operations/operation-api-v1-media-upload-post.md): Upload a single file.
- [Upload Batch](/api-reference/operations/operation-api-v1-media-upload-batch-post.md): Upload multiple files at once.
- [Upload Chunk](/api-reference/operations/operation-api-v1-media-upload-chunk-post.md): Upload a single chunk of a large media file.
- [Download File](/api-reference/operations/operation-api-v1-media-download-asset-id-get.md): Download a file by asset ID.
- [Stream File](/api-reference/operations/operation-api-v1-media-stream-asset-id-get.md): Stream a file inline (for images, audio, video).
- [Stream Thumbnail](/api-reference/operations/operation-api-v1-media-stream-asset-id-thumbnail-get.md): Stream an asset's thumbnail.
- [Get File By Name](/api-reference/operations/operation-api-v1-media-file-filename-get.md): Get a library file by its original filename. Used by form filler to display media files.
- [List Assets](/api-reference/operations/operation-api-v1-media-assets-get.md): List media assets with optional filters.
- [Get Asset](/api-reference/operations/operation-api-v1-media-assets-asset-id-get.md): Get asset metadata.
- [Update Asset](/api-reference/operations/operation-api-v1-media-assets-asset-id-put.md): Update asset metadata.
- [Delete Asset](/api-reference/operations/operation-api-v1-media-assets-asset-id-delete.md): Delete an asset and its stored files.
- [Get Presigned Url](/api-reference/operations/operation-api-v1-media-assets-asset-id-presigned-get.md): Get a proxy URL for direct file access.
- [Link Asset To Response](/api-reference/operations/operation-api-v1-media-assets-asset-id-link-post.md): Link an asset to a form response.
- [Get Assets For Response](/api-reference/operations/operation-api-v1-media-assets-by-response-response-id-get.md): Get all assets associated with a response.
- [Get Asset By Upload Id](/api-reference/operations/operation-api-v1-media-assets-by-upload-upload-id-get.md): Resolve a Media Track upload_id to its canonical MediaAsset.id.
- [Upload Library File](/api-reference/operations/operation-api-v1-media-library-upload-post.md): Upload a file to the tenant's shared media library.
- [Upload Library Files Batch](/api-reference/operations/operation-api-v1-media-library-upload-batch-post.md): Upload multiple files to the tenant's media library at once.
- [List Library](/api-reference/operations/operation-api-v1-media-library-get.md): List all files in the tenant's shared media library.
- [Get Library Asset By Filename](/api-reference/operations/operation-api-v1-media-library-by-filename-filename-get.md): Look up a library asset by its original filename.
- [Get Library Asset Url](/api-reference/operations/operation-api-v1-media-library-asset-id-url-get.md): Get the stream URL for a library asset.
- [Update Library Asset Status](/api-reference/operations/operation-api-v1-media-library-asset-id-status-patch.md): Update a library asset's approval status (pending/approved/rejected).
- [Delete Library Asset](/api-reference/operations/operation-api-v1-media-library-asset-id-delete.md): Delete a file from the tenant's media library.
- [Get Storage Usage](/api-reference/operations/operation-api-v1-media-storage-usage-get.md): GET /api/v1/media/storage/usage.
- [Send Notification](/api-reference/operations/operation-api-v1-notification-send-post.md): POST /api/v1/notification/send: takes NotificationService_SendNotificationRequest.
- [Send Batch](/api-reference/operations/operation-api-v1-notification-send-batch-post.md): POST /api/v1/notification/send/batch: takes NotificationService_SendBatchRequest.
- [List Templates](/api-reference/operations/operation-api-v1-notification-templates-get.md): GET /api/v1/notification/templates.
- [Create Template](/api-reference/operations/operation-api-v1-notification-templates-post.md): POST /api/v1/notification/templates: takes NotificationService_TemplateCreateRequest.
- [Preview Template Live](/api-reference/operations/operation-api-v1-notification-templates-preview-post.md): POST /api/v1/notification/templates/preview: takes NotificationService_TemplateLivePreviewRequest.
- [Get Template](/api-reference/operations/operation-api-v1-notification-templates-template-id-get.md): GET /api/v1/notification/templates/{template_id}.
- [Update Template](/api-reference/operations/operation-api-v1-notification-templates-template-id-put.md): PUT /api/v1/notification/templates/{template_id}: takes NotificationService_TemplateUpdateRequest.
- [Delete Template](/api-reference/operations/operation-api-v1-notification-templates-template-id-delete.md): DELETE /api/v1/notification/templates/{template_id}.
- [Preview Template](/api-reference/operations/operation-api-v1-notification-templates-template-id-preview-post.md): POST /api/v1/notification/templates/{template_id}/preview: takes NotificationService_TemplatePreviewRequest.
- [Get Preferences](/api-reference/operations/operation-api-v1-notification-preferences-get.md): GET /api/v1/notification/preferences.
- [Set Preference](/api-reference/operations/operation-api-v1-notification-preferences-post.md): POST /api/v1/notification/preferences: takes NotificationService_UserPreferenceRequest.
- [Update Preference](/api-reference/operations/operation-api-v1-notification-preferences-pref-id-put.md): PUT /api/v1/notification/preferences/{pref_id}: takes NotificationService_UserPreferenceRequest.
- [Delete Preference](/api-reference/operations/operation-api-v1-notification-preferences-pref-id-delete.md): DELETE /api/v1/notification/preferences/{pref_id}.
- [Get Settings](/api-reference/operations/operation-api-v1-notification-settings-get.md): GET /api/v1/notification/settings: returns NotificationService_NotificationSettingsResponse.
- [Update Settings](/api-reference/operations/operation-api-v1-notification-settings-put.md): PUT /api/v1/notification/settings: takes NotificationService_NotificationSettingsRequest, returns NotificationService_NotificationSettingsResponse.
- [Send Test Notification](/api-reference/operations/operation-api-v1-notification-test-post.md): POST /api/v1/notification/test: takes NotificationService_TestNotificationRequest.
- [List Notifications](/api-reference/operations/operation-api-v1-notification-history-get.md): GET /api/v1/notification/history.
- [Cancel Notifications](/api-reference/operations/operation-api-v1-notification-cancel-post.md): POST /api/v1/notification/cancel: takes NotificationService_CancelNotificationsRequest.
- [Get Notification](/api-reference/operations/operation-api-v1-notification-notification-id-get.md): GET /api/v1/notification/{notification_id}.
- [List System Audit Logs](/api-reference/operations/operation-api-v1-audit-logs-system-get.md): System-wide audit logs - for super:admin and host admin only.
- [Get Audit Log](/api-reference/operations/operation-api-v1-audit-logs-log-id-get.md): Get a specific audit log entry by ID.
- [Verify Chain Integrity](/api-reference/operations/operation-api-v1-audit-chain-verify-get.md): Verify the integrity of the audit log chain.
- [Get Data Access Report](/api-reference/operations/operation-api-v1-audit-compliance-gdpr-data-access-user-id-get.md): Get GDPR data access report for a specific user.
- [Record Consent](/api-reference/operations/operation-api-v1-audit-compliance-consent-post.md): Record or update a consent decision for a user.
- [Get User Consents](/api-reference/operations/operation-api-v1-audit-compliance-consent-user-id-get.md): Get all consent records for a specific user.
- [Export Audit Logs](/api-reference/operations/operation-api-v1-audit-export-post.md): Export audit logs in the specified format (json or csv).
- [Invalidate Tenant Plan Context](/api-reference/operations/operation-internal-tenants-tenant-id-plan-context-invalidate-post.md): Internal endpoint: invalidate the cached plan context for a single tenant.
- [List Flags](/api-reference/operations/operation-api-v1-flags-get.md): List all feature flags with pagination. Requires feature_flag:read.
- [Create Flag](/api-reference/operations/operation-api-v1-flags-post.md): Create a new feature flag. Requires feature_flag:create.
- [Get Flag](/api-reference/operations/operation-api-v1-flags-flag-key-get.md): Get a feature flag by key. Requires feature_flag:read.
- [Update Flag](/api-reference/operations/operation-api-v1-flags-flag-key-put.md): Update a feature flag. Requires feature_flag:update.
- [Delete Flag](/api-reference/operations/operation-api-v1-flags-flag-key-delete.md): Delete a feature flag and all associated rules/evaluations. Requires feature_flag:delete.
- [Toggle Flag](/api-reference/operations/operation-api-v1-flags-flag-key-toggle-post.md): Toggle a feature flag's enabled state. Requires feature_flag:toggle.
- [Archive Flag](/api-reference/operations/operation-api-v1-flags-flag-key-archive-post.md): Archive a feature flag (disables and hides from list). Requires feature_flag:update.
- [Evaluate Flag](/api-reference/operations/operation-api-v1-evaluate-post.md): Evaluate a single feature flag against the provided context.
- [Evaluate Batch](/api-reference/operations/operation-api-v1-evaluate-batch-post.md): Evaluate multiple feature flags in a single request.
- [List Plans](/api-reference/operations/operation-api-v1-plans-get.md): List all available subscription plans and their features.
- [Get Entitlement Catalogue](/api-reference/operations/operation-api-v1-plans-catalogue-get.md): Return the canonical Phase 2 entitlement catalogue metadata.
- [Get Plan](/api-reference/operations/operation-api-v1-plans-tier-get.md): Get details for a specific plan tier.
- [Get Tenant Plan Tier](/api-reference/operations/operation-api-v1-plans-tenant-id-tier-get.md): Get plan tier for a tenant. Looks up from backend API.
- [Get Tenant Limits](/api-reference/operations/operation-api-v1-plans-tenant-id-limits-get.md): Get limits for a tenant.
- [Get Tenant Features](/api-reference/operations/operation-api-v1-plans-tenant-id-features-get.md): Get feature flags for a tenant.
- [Get Tenant Entitlements](/api-reference/operations/operation-api-v1-plans-tenant-id-entitlements-get.md): Get normalized plan limits, feature entitlements, and subscription state.
- [Check Limit](/api-reference/operations/operation-api-v1-quota-check-post.md): Check if quota is available.
- [Consume Quota](/api-reference/operations/operation-api-v1-quota-consume-post.md): Consume quota after successful operation.
- [Rollback Quota](/api-reference/operations/operation-api-v1-quota-rollback-post.md): Rollback quota consumption.
- [Get Usage](/api-reference/operations/operation-api-v1-quota-usage-limit-type-get.md): Get current usage for a limit type.
- [Get All Usage](/api-reference/operations/operation-api-v1-quota-usage-get.md): Get all usage counters for tenant.
- [Reset Tenant](/api-reference/operations/operation-api-v1-quota-reset-post.md): Reset all counters for tenant (admin only).
- [Readiness Check](/api-reference/operations/operation-ready-get.md): Readiness check endpoint.
- [Backend_ActivateTrialDto](/api-reference/schemas/backend-activatetrialdto-ec86f2e80e.md): Fields: address and tax_id.
- [Backend_AppConfigurationDto](/api-reference/schemas/backend-appconfigurationdto-b43b803f65.md): Fields: is_multi_tenant_enabled, multi_tenancy_strategy, host_main_domain, is_user_logged_in, user_preferences, current_tenant and 4 more.
- [Backend_AppVersionCheckResponseDto](/api-reference/schemas/backend-appversioncheckresponsedto-6c72b8eade.md): Fields: latest_version, download_url, checksum_sha256, min_version and release_notes.
- [Backend_AuditEventIngestRequest](/api-reference/schemas/backend-auditeventingestrequest-5835f9775d.md): Client-originated audit event relayed to the centralized audit-service.
- [Backend_AuditLogDto](/api-reference/schemas/backend-auditlogdto-5cac555828.md): Fields: id, entity, service_name, action, changes, user_id and 15 more.
- [Backend_AuditLogListDto](/api-reference/schemas/backend-auditloglistdto-38ea4dd52f.md): Fields: total, items, has_next, has_previous, limit and skip.
- [Backend_AuthenticatorTransport](/api-reference/schemas/backend-authenticatortransport-99cba1153f.md): How an authenticator communicates to the client/browser.
- [Backend_BillingAddressDto](/api-reference/schemas/backend-billingaddressdto-4cf9dcd9fa.md): Fields: individual_name, business_name, line1, line2, city, state and 2 more.
- [Backend_BillingConfigDto](/api-reference/schemas/backend-billingconfigdto-a2a6ee7028.md): Field: publishable_key.
- [Backend_BillingRecordDto](/api-reference/schemas/backend-billingrecorddto-b31535330f.md): Fields: id, created_at, scope, actor, user_id, user_name and 20 more.
- [Backend_BillingRecordListDto](/api-reference/schemas/backend-billingrecordlistdto-f4e335d23c.md): Fields: items, skip, limit, total, has_previous and has_next.
- [Backend_Body_bulk_upload_users_api_v1_users_bulk_upload_post](/api-reference/schemas/backend-body-bulk-upload-users-api-v1-users-bulk-upload-post-40ef5bd154.md): Fields: tenant_id, default_role_id, default_role_name, send_invitation and file.
- [Backend_Body_login_api_v1_account_login_post](/api-reference/schemas/backend-body-login-api-v1-account-login-post-418fb31a87.md): Fields: grant_type, username, password, scope, client_id and client_secret.
- [Backend_Body_login_host_admin_api_v1_account_login_host_admin_post](/api-reference/schemas/backend-body-login-host-admin-api-v1-account-login-host-admin-post-63044dcdec.md): Fields: grant_type, username, password, scope, client_id and client_secret.
- [Backend_Body_login_new_api_v1_account_login_new_post](/api-reference/schemas/backend-body-login-new-api-v1-account-login-new-post-7a5f901167.md): Fields: grant_type, username, password, scope, client_id and client_secret.
- [Backend_Body_login_super_admin_api_v1_account_login_super_admin_post](/api-reference/schemas/backend-body-login-super-admin-api-v1-account-login-super-admin-post-e9417ea90b.md): Fields: grant_type, username, password, scope, client_id and client_secret.
- [Backend_Body_passkey_login_api_v1_account_passkey_login_post](/api-reference/schemas/backend-body-passkey-login-api-v1-account-passkey-login-post-130d3781b9.md): Fields: email and credential.
- [Backend_Body_passkey_register_api_v1_account_passkey_register_post](/api-reference/schemas/backend-body-passkey-register-api-v1-account-passkey-register-post-fac7a81cba.md): Fields: email and credential.
- [Backend_Body_update_profile_picture_api_v1_users__user_id__update_profile_picture_put](/api-reference/schemas/backend-body-update-profile-picture-api-v1-users-user-id-update-profile-picture-put-f81a5c112c.md): Field: file.
- [Backend_BulkUserRequestDto](/api-reference/schemas/backend-bulkuserrequestdto-cc1956263f.md): Field: user_ids.
- [Backend_BulkUserUploadResponseDto](/api-reference/schemas/backend-bulkuseruploadresponsedto-0571e0cd8f.md): DTO for bulk user upload response
- [Backend_BulkUserUploadResultDto](/api-reference/schemas/backend-bulkuseruploadresultdto-48f2f6aebf.md): DTO for individual user upload result
- [Backend_CeleryMetricsDto](/api-reference/schemas/backend-celerymetricsdto-49e2d9128d.md): Fields: workers_online, active_tasks, scheduled_tasks, reserved_tasks and worker_details.
- [Backend_ChangeEmailConfirmRequestDto](/api-reference/schemas/backend-changeemailconfirmrequestdto-2605c9b641.md): Field: token.
- [Backend_ChangeEmailRequestDto](/api-reference/schemas/backend-changeemailrequestdto-6feb699532.md): Field: new_email.
- [Backend_ChangeEmailResponseDto](/api-reference/schemas/backend-changeemailresponsedto-20e1488c62.md): Field: message.
- [Backend_CheckoutRequestDto](/api-reference/schemas/backend-checkoutrequestdto-481b5dd219.md): Fields: price_id, tenant_id, mode and email.
- [Backend_CheckoutResponseDto](/api-reference/schemas/backend-checkoutresponsedto-4588ecfd01.md): Field: checkout_url.
- [Backend_CompleteIncompletePaymentRequestDto](/api-reference/schemas/backend-completeincompletepaymentrequestdto-fd9a34863a.md): Fields: subscription_id and tenant_id.
- [Backend_ConfirmNativeSubscriptionRequestDto](/api-reference/schemas/backend-confirmnativesubscriptionrequestdto-c9b2ae4bcc.md): Field: billing_record_id.
- [Backend_CreateNativeSubscriptionRequestDto](/api-reference/schemas/backend-createnativesubscriptionrequestdto-355a817343.md): Fields: price_id, tenant_id, mode and email.
- [Backend_CreateNotificationBannerSettingDto](/api-reference/schemas/backend-createnotificationbannersettingdto-c10872f428.md): Fields: is_enabled and message.
- [Backend_CreatePlanDto](/api-reference/schemas/backend-createplandto-5f23e90b85.md): Fields: currency, interval, product_id, amount and trial_period_days.
- [Backend_CreatePricingDto](/api-reference/schemas/backend-createpricingdto-c5ec814c3d.md): Fields: currency, unit_amount, product, active and recurring.
- [Backend_CreateProductDto](/api-reference/schemas/backend-createproductdto-f35d014276.md): Fields: name, description, tax_code and active.
- [Backend_CreateRoleDto](/api-reference/schemas/backend-createroledto-0210bfd3a8.md): Fields: name, description, tenant_id, permissions and is_immutable.
- [Backend_CreateRoleResponseDto](/api-reference/schemas/backend-createroleresponsedto-7610ae55ee.md): Field: id.
- [Backend_CreateTenantDataGovernanceDto](/api-reference/schemas/backend-createtenantdatagovernancedto-c53f3be484.md): Fields: tenant_id, max_offline_duration_hours, force_revalidation_hours, media_upload_max_size_mb, media_upload_allowed_types, local_retention_days and 1 more.
- [Backend_CreateTenantDto](/api-reference/schemas/backend-createtenantdto-cd200d76a4.md): Fields: name, subdomain, admin_email, admin_password, first_name, last_name and 1 more.
- [Backend_CreateTenantResponseDto](/api-reference/schemas/backend-createtenantresponsedto-24778c2f0b.md): Field: id.
- [Backend_CreateUserDto](/api-reference/schemas/backend-createuserdto-b424e7defc.md): Fields: first_name, last_name, email, gender, tenant_id, role_id and 3 more.
- [Backend_CreateUserResponseDto](/api-reference/schemas/backend-createuserresponsedto-b14d646235.md): Field: id.
- [Backend_DashboardMetricsDto](/api-reference/schemas/backend-dashboardmetricsdto-4d17501d37.md): Fields: filter, joined_users, total_users and timeseries.
- [Backend_DeprecatedMobileSecurityPolicyConfigDto](/api-reference/schemas/backend-deprecatedmobilesecuritypolicyconfigdto-9e2199afb4.md): DEPRECATED: For old mobile clients. Remove after migration window.
- [Backend_DeprecatedMobileSecurityPolicyDto](/api-reference/schemas/backend-deprecatedmobilesecuritypolicydto-26fe21cbe3.md): Backward-compatible adapter for old mobile clients.
- [Backend_DownloadAuditRequestDto](/api-reference/schemas/backend-downloadauditrequestdto-c5e1bd9710.md): Fields: action and total_records.
- [Backend_DownloadResponseDto](/api-reference/schemas/backend-downloadresponsedto-f11523e62f.md): Field: message.
- [Backend_EnterpriseSignupDto](/api-reference/schemas/backend-enterprisesignupdto-a0b8b97769.md): Fields: name, email, company, phone, message and tenant_id.
- [Backend_Feature](/api-reference/schemas/backend-feature-2027695221.md): One of: chat, report, analytics, organization, teams and stripe.
- [Backend_FeatureDto](/api-reference/schemas/backend-featuredto-af3e00c271.md): Fields: name and enabled.
- [Backend_FrontendLogEntry](/api-reference/schemas/backend-frontendlogentry-306ecae18a.md): Frontend log entry model
- [Backend_Gender](/api-reference/schemas/backend-gender-58aaeec09d.md): One of: male, female, other and prefer_not_to_say.
- [Backend_HTTPValidationError](/api-reference/schemas/backend-httpvalidationerror-b82f7839b1.md): Field: detail.
- [Backend_HasPasskeysDto](/api-reference/schemas/backend-haspasskeysdto-9d9918b377.md): Field: has_passkeys.
- [Backend_HealthCheckResponseDto](/api-reference/schemas/backend-healthcheckresponsedto-7e1accbe82.md): Fields: status, postgres_status and redis_status.
- [Backend_IncidentDto](/api-reference/schemas/backend-incidentdto-c1705fbacc.md): Fields: id, type, severity, message, tenant_id and created_at.
- [Backend_InfrastructureMetricsDto](/api-reference/schemas/backend-infrastructuremetricsdto-68d176034f.md): Fields: celery_queue_size, redis_memory_mb, db_connections, storage_used_gb and webhook_failures.
- [Backend_InvoiceDto](/api-reference/schemas/backend-invoicedto-1b8b9080ea.md): Fields: id, amount_due, amount_paid, amount_remaining, amount_overpaid, attempt_count and 15 more.
- [Backend_InvoiceListDto](/api-reference/schemas/backend-invoicelistdto-a5e37bf2bc.md): Fields: items, total, skip, limit, has_next and has_previous.
- [Backend_LoginResponseDto](/api-reference/schemas/backend-loginresponsedto-5578e3d759.md): Response after successful login with tenant selection info
- [Backend_MagicLinkResponseDto](/api-reference/schemas/backend-magiclinkresponsedto-31a68a6458.md): Field: message.
- [Backend_MeResponseDto](/api-reference/schemas/backend-meresponsedto-007f2a14fa.md): Fields: id, first_name, last_name, email, gender, role_id and 13 more.
- [Backend_NativeSubscriptionResponseDto](/api-reference/schemas/backend-nativesubscriptionresponsedto-22bafd8b40.md): Fields: client_secret, subscription_id, customer_id, billing_record_id, is_upgrade and requires_confirmation.
- [Backend_NotificationBannerSettingDto](/api-reference/schemas/backend-notificationbannersettingdto-28e88cbb83.md): Fields: is_enabled, message, id, tenant_id, created_at and updated_at.
- [Backend_OSMetricsDto](/api-reference/schemas/backend-osmetricsdto-21f13fe5f1.md): Fields: cpu_percent, memory_percent, memory_total_mb and memory_used_mb.
- [Backend_PasswordResetConfirmRequestDto](/api-reference/schemas/backend-passwordresetconfirmrequestdto-be829b2357.md): Field: new_password.
- [Backend_PasswordResetRequestDto](/api-reference/schemas/backend-passwordresetrequestdto-6feb304a01.md): Field: email.
- [Backend_PasswordResetResponseDto](/api-reference/schemas/backend-passwordresetresponsedto-6dd4522789.md): Field: message.
- [Backend_PaymentMethodCardDto](/api-reference/schemas/backend-paymentmethodcarddto-8a5b08d4b2.md): Fields: brand, last4, exp_month, exp_year and country.
- [Backend_PaymentMethodDto](/api-reference/schemas/backend-paymentmethoddto-e072310f2c.md): Fields: id, type, card, created and is_default.
- [Backend_PaymentMethodListDto](/api-reference/schemas/backend-paymentmethodlistdto-e8814be407.md): Fields: items and customer_id.
- [Backend_Permission](/api-reference/schemas/backend-permission-f0b845e64b.md): One of: super:admin, full:access, user:read_and_write_only, user:delete_only, user:self_read_and_write_only, user:role_assign_or_remove_only and 134 more.
- [Backend_PermissionCategory](/api-reference/schemas/backend-permissioncategory-accd03496d.md): Logical grouping of permissions.
- [Backend_PermissionDangerLevel](/api-reference/schemas/backend-permissiondangerlevel-4c05f0768a.md): Categorizes permissions by potential system impact.
- [Backend_PermissionDto](/api-reference/schemas/backend-permissiondto-fff0936857.md): Fields: name, display_name, description, category and danger_level.
- [Backend_PermissionGroupedDto](/api-reference/schemas/backend-permissiongroupeddto-e4796298d2.md): Fields: category and permissions.
- [Backend_PlanDto](/api-reference/schemas/backend-plandto-591471c431.md): Fields: id, active, amount, amount_decimal, billing_scheme, currency and 5 more.
- [Backend_PlanListDto](/api-reference/schemas/backend-planlistdto-c6e93917e7.md): Fields: items, total, skip, limit, has_next and has_previous.
- [Backend_PlanTierResponseDto](/api-reference/schemas/backend-plantierresponsedto-d96e30612f.md): Fields: tier and name.
- [Backend_PlatformHealthDto](/api-reference/schemas/backend-platformhealthdto-d90af6144e.md): Fields: status, api_uptime_seconds, last_incident_at and active_incidents.
- [Backend_PricingDto](/api-reference/schemas/backend-pricingdto-6f370db28d.md): Fields: id, currency, unit_amount, product, active, recurring and 3 more.
- [Backend_PricingListDto](/api-reference/schemas/backend-pricinglistdto-39d7e3ce33.md): Fields: pricings and has_more.
- [Backend_ProductDto](/api-reference/schemas/backend-productdto-45e8c99190.md): Fields: id, name, description, tax_code and active.
- [Backend_ProductListDto](/api-reference/schemas/backend-productlistdto-a35d4183a4.md): Fields: products and has_more.
- [Backend_ProvisionUserDto](/api-reference/schemas/backend-provisionuserdto-a7d98511b1.md): DTO for provisioning a user to a tenant (create or invite)
- [Backend_ProvisionUserResponseDto](/api-reference/schemas/backend-provisionuserresponsedto-af603590a1.md): Response DTO for user provisioning
- [Backend_RecurringDto](/api-reference/schemas/backend-recurringdto-a1f533306f.md): Fields: interval, interval_count and usage_type.
- [Backend_RegisteredPasskeyCredentialsDto](/api-reference/schemas/backend-registeredpasskeycredentialsdto-97afa0e470.md): Fields: credential_id, public_key, sigin_count, transports, created_at and last_used_at.
- [Backend_RemoteWipeCommandDto](/api-reference/schemas/backend-remotewipecommanddto-4077d15808.md): Fields: target_user_id and reason.
- [Backend_ReservedSubdomainsDto](/api-reference/schemas/backend-reservedsubdomainsdto-0b3de77ddf.md): Field: subdomains.
- [Backend_RoleDto](/api-reference/schemas/backend-roledto-67a8c19f32.md): Fields: id, name, description, permissions, is_immutable, created_at and 4 more.
- [Backend_RoleListDto](/api-reference/schemas/backend-rolelistdto-5c10c1c004.md): Fields: items, skip, limit, total, has_previous and has_next.
- [Backend_RoleScope](/api-reference/schemas/backend-rolescope-986b18b833.md): Defines where a role can be used.
- [Backend_RuntimeSecurityConfigConfigDto](/api-reference/schemas/backend-runtimesecurityconfigconfigdto-eb429fabf3.md): Fields: screenshot_prevention_mode, root_detection_mode, biometric_required_mode, session_timeout_minutes, wifi_only_sync, battery_aware_sync and 7 more.
- [Backend_RuntimeSecurityConfigDto](/api-reference/schemas/backend-runtimesecurityconfigdto-6fd5420810.md): Fields: id, screenshot_prevention_mode, root_detection_mode, biometric_required_mode, session_timeout_minutes, wifi_only_sync and 10 more.
- [Backend_SetPrimaryTenantDto](/api-reference/schemas/backend-setprimarytenantdto-2023e6d94c.md): DTO for setting primary tenant
- [Backend_SetupIntentDto](/api-reference/schemas/backend-setupintentdto-cffd034048.md): Fields: client_secret and setup_intent_id.
- [Backend_SubdomainAvailabilityDto](/api-reference/schemas/backend-subdomainavailabilitydto-1443b51036.md): Fields: is_available and reason.
- [Backend_SubmissionMetricsDto](/api-reference/schemas/backend-submissionmetricsdto-53063ef6d6.md): Fields: submissions_today, submissions_this_week, submissions_this_month and submissions_trend.
- [Backend_SubscriptionMetricsDto](/api-reference/schemas/backend-subscriptionmetricsdto-b8ff6de0f8.md): Fields: mrr, active_subscriptions, trials_running, cancelled_this_month and plans_breakdown.
- [Backend_SubscriptionPlanDto](/api-reference/schemas/backend-subscriptionplandto-3536ed2a97.md): Fields: id, plan_levels, is_trial, tenant_id, actor, user_id and 4 more.
- [Backend_SuperadminDashboardDto](/api-reference/schemas/backend-superadmindashboarddto-2f95ba6abf.md): Fields: tenants, submissions, users, subscriptions, infrastructure, incidents and 4 more.
- [Backend_SwitchTenantRequestDto](/api-reference/schemas/backend-switchtenantrequestdto-109a073cee.md): Request to switch active tenant
- [Backend_SwitchTenantResponseDto](/api-reference/schemas/backend-switchtenantresponsedto-557e91b7a6.md): Response after switching tenant with new tokens and context
- [Backend_SystemMetricsResponseDto](/api-reference/schemas/backend-systemmetricsresponsedto-d200f89821.md): Fields: os_metrics and celery_metrics.
- [Backend_TenantAccessUpdateDto](/api-reference/schemas/backend-tenantaccessupdatedto-3177c8ec59.md): DTO for updating a user's per-tenant access (activate/deactivate in the active tenant)
- [Backend_TenantActivityDto](/api-reference/schemas/backend-tenantactivitydto-7dcc16ba06.md): Fields: tenant_id, tenant_name, subdomain, plan, users_count, surveys_count and 3 more.
- [Backend_TenantDataGovernanceConfigDto](/api-reference/schemas/backend-tenantdatagovernanceconfigdto-014c260309.md): Fields: tenant_id, max_offline_duration_hours, force_revalidation_hours, media_upload_max_size_mb, media_upload_allowed_types, local_retention_days and 2 more.
- [Backend_TenantDataGovernanceDto](/api-reference/schemas/backend-tenantdatagovernancedto-180efcbf5f.md): Fields: id, tenant_id, max_offline_duration_hours, force_revalidation_hours, media_upload_max_size_mb, media_upload_allowed_types and 3 more.
- [Backend_TenantDataGovernanceResponseDto](/api-reference/schemas/backend-tenantdatagovernanceresponsedto-d90a8842aa.md): Fields: message and governance.
- [Backend_TenantDto](/api-reference/schemas/backend-tenantdto-b9c2bf7a81.md): Fields: id, name, subdomain, is_active, custom_domain, custom_domain_status and 16 more.
- [Backend_TenantInfoDto](/api-reference/schemas/backend-tenantinfodto-3aa396b19f.md): Tenant information for selection
- [Backend_TenantInvoiceExportDto](/api-reference/schemas/backend-tenantinvoiceexportdto-341c930220.md): Fields: id, invoice_number, created, due_date, status, currency and 11 more.
- [Backend_TenantInvoiceLineItemDto](/api-reference/schemas/backend-tenantinvoicelineitemdto-5c5e2870ad.md): Fields: description, quantity, unit_amount, amount and currency.
- [Backend_TenantInvoiceListDto](/api-reference/schemas/backend-tenantinvoicelistdto-d564a4d9d3.md): Fields: items, total, skip, limit, has_next and has_previous.
- [Backend_TenantListDto](/api-reference/schemas/backend-tenantlistdto-bb0dd28b63.md): Fields: items, skip, limit, total, has_previous and has_next.
- [Backend_TenantMetricsDto](/api-reference/schemas/backend-tenantmetricsdto-ad649af931.md): Fields: total_tenants, active_tenants_30d, new_tenants_this_month and suspended_tenants.
- [Backend_TenantPlanContextResponseDto](/api-reference/schemas/backend-tenantplancontextresponsedto-cfe702fa66.md): Fields: tenant_id, tier, name, subscription_status, is_active, is_trial and 3 more.
- [Backend_TenantSelectionRequestDto](/api-reference/schemas/backend-tenantselectionrequestdto-36226bd840.md): Request to select a tenant and get tokens
- [Backend_TenantSelectionResponseDto](/api-reference/schemas/backend-tenantselectionresponsedto-e9c438b891.md): Response after tenant selection with tokens
- [Backend_TimeSeriesDto](/api-reference/schemas/backend-timeseriesdto-59f782b33b.md): Fields: time_or_date and count.
- [Backend_TimeSeriesPointDto](/api-reference/schemas/backend-timeseriespointdto-f9a436c50d.md): Fields: date and count.
- [Backend_TokenSetDto](/api-reference/schemas/backend-tokensetdto-c03c3c3d30.md): Fields: refresh_token, refresh_token_expires_in, access_token, token_type and expires_in.
- [Backend_UpdateBillingAddressDto](/api-reference/schemas/backend-updatebillingaddressdto-a96c248e7a.md): Fields: address and tax_id.
- [Backend_UpdatePlanDto](/api-reference/schemas/backend-updateplandto-2433de4034.md): Fields: trial_period_days, active and metadata.
- [Backend_UpdatePricingDto](/api-reference/schemas/backend-updatepricingdto-6a5173adda.md): Fields: active, metadata and tax_behavior.
- [Backend_UpdateRoleDto](/api-reference/schemas/backend-updateroledto-11a3356246.md): Fields: name, description, tenant_id, permissions and is_immutable.
- [Backend_UpdateRolePermissionsDto](/api-reference/schemas/backend-updaterolepermissionsdto-cc5e27857c.md): Field: permissions.
- [Backend_UpdateRuntimeSecurityConfigDto](/api-reference/schemas/backend-updateruntimesecurityconfigdto-71765e5a41.md): Fields: screenshot_prevention_mode, root_detection_mode, biometric_required_mode, session_timeout_minutes, wifi_only_sync, battery_aware_sync and 6 more.
- [Backend_UpdateTenantDataGovernanceDto](/api-reference/schemas/backend-updatetenantdatagovernancedto-54fa3b7f30.md): Fields: max_offline_duration_hours, force_revalidation_hours, media_upload_max_size_mb, media_upload_allowed_types, local_retention_days and remote_wipe_enabled.
- [Backend_UpdateTenantDto](/api-reference/schemas/backend-updatetenantdto-dc31cf016f.md): Fields: is_active, is_dormant, custom_domain, subscription_id, plan_tier, custom_domain_status and 9 more.
- [Backend_UpdateTenantResponseDto](/api-reference/schemas/backend-updatetenantresponsedto-f75aa0d8da.md): Field: message.
- [Backend_UpdateUserDto](/api-reference/schemas/backend-updateuserdto-f76ba6d54a.md): Fields: first_name, last_name, email, gender, image_url, role_id and 4 more.
- [Backend_UserActivationRequestDto](/api-reference/schemas/backend-useractivationrequestdto-4493d0eebd.md): Field: token.
- [Backend_UserCountDto](/api-reference/schemas/backend-usercountdto-fcc6c2e8f0.md): Field: total.
- [Backend_UserDto](/api-reference/schemas/backend-userdto-dff074e6e0.md): Fields: id, first_name, last_name, email, gender, role_id and 11 more.
- [Backend_UserInfoDto](/api-reference/schemas/backend-userinfodto-ff6ae5e858.md): User information returned after login
- [Backend_UserListDto](/api-reference/schemas/backend-userlistdto-f264831fe0.md): Fields: items, skip, limit, total, has_previous and has_next.
- [Backend_UserMetricsDto](/api-reference/schemas/backend-usermetricsdto-a515a0d4e1.md): Fields: total_users, active_users_30d and new_users_this_month.
- [Backend_UserPreferenceDto](/api-reference/schemas/backend-userpreferencedto-82d1d1bb6a.md): Fields: user_id and preferences.
- [Backend_UserProfileImageUpdateDto](/api-reference/schemas/backend-userprofileimageupdatedto-3f65b4d22e.md): Field: image_url.
- [Backend_UserResendActivationEmailRequestDto](/api-reference/schemas/backend-userresendactivationemailrequestdto-c1e2c2a500.md): Fields: email, id, first_name and tenant_id.
- [Backend_UserRoleUpdateRequestDto](/api-reference/schemas/backend-userroleupdaterequestdto-8e940551d0.md): Field: role_id.
- [Backend_UserTenantCreateDto](/api-reference/schemas/backend-usertenantcreatedto-9349389c4c.md): DTO for creating user-tenant relationship
- [Backend_UserTenantDto](/api-reference/schemas/backend-usertenantdto-55d675b543.md): DTO for user-tenant relationship
- [Backend_UserTenantListDto](/api-reference/schemas/backend-usertenantlistdto-0548bfc1ea.md): DTO for listing user tenants
- [Backend_UserTenantUpdateDto](/api-reference/schemas/backend-usertenantupdatedto-0d1b7de16b.md): DTO for updating user-tenant relationship
- [Backend_ValidationError](/api-reference/schemas/backend-validationerror-b5b4376c23.md): Fields: loc, msg and type.
- [SurveyService_AddQuestionToSurveyRequest](/api-reference/schemas/surveyservice-addquestiontosurveyrequest-77e3a6e34e.md): Fields: question_id and survey_id.
- [SurveyService_AddQuestionToSurveyResponse](/api-reference/schemas/surveyservice-addquestiontosurveyresponse-ae78e0a89a.md): Fields: survey_id, question_id, question_name and question.
- [SurveyService_AvailableTriggersResponse](/api-reference/schemas/surveyservice-availabletriggersresponse-4eb9e05311.md): Response model for available trigger values with assignment info.
- [SurveyService_BackfillAnchorSchema](/api-reference/schemas/surveyservice-backfillanchorschema-d4b5cb9bc6.md): Anchor configuration for timeline-aware backfill
- [SurveyService_Body_import_questions_api_v1_surveys_question_bank_questions_import_post](/api-reference/schemas/surveyservice-body-import-questions-api-v1-surveys-question-bank-questions-import-post-60ac611716.md): Fields: file and category_id.
- [SurveyService_Body_import_template_from_xlsform_api_v1_templates_import_xlsform_post](/api-reference/schemas/surveyservice-body-import-template-from-xlsform-api-v1-templates-import-xlsform-post-9975f0f41d.md): Fields: file, name, category_id, description and is_public.
- [SurveyService_Body_import_xlsform_api_v1_surveys_import_xlsform_post](/api-reference/schemas/surveyservice-body-import-xlsform-api-v1-surveys-import-xlsform-post-b3f0fa6048.md): Fields: file, name, description, project_id, workspace_id, is_anonymous and 4 more.
- [SurveyService_Body_upload_survey_media_api_v1_surveys__survey_id__media_post](/api-reference/schemas/surveyservice-body-upload-survey-media-api-v1-surveys-survey-id-media-post-8a256a406b.md): Field: file.
- [SurveyService_Body_upload_xlsform_as_new_version_api_v1_surveys__survey_id__versions_upload_post](/api-reference/schemas/surveyservice-body-upload-xlsform-as-new-version-api-v1-surveys-survey-id-versions-upload-post-7627bf80b3.md): Field: file.
- [SurveyService_CalendarColumnSchema](/api-reference/schemas/surveyservice-calendarcolumnschema-1ed497aaca.md): Column definition for calendar_grid question type
- [SurveyService_CalendarConfigSchema](/api-reference/schemas/surveyservice-calendarconfigschema-547e3ac662.md): Configuration for calendar_grid question type
- [SurveyService_CalendarRuleSchema](/api-reference/schemas/surveyservice-calendarruleschema-08f16a0fe4.md): Rule for auto-prefilling calendar column values
- [SurveyService_ChoiceSchema](/api-reference/schemas/surveyservice-choiceschema-d6eb4de0b4.md): Choice list item (XLSForm choices sheet)
- [SurveyService_CollectionGrantResponse](/api-reference/schemas/surveyservice-collectiongrantresponse-76f52aa023.md): Fields: id, kind, survey_id, survey_version_id, user_id, device_id and 4 more.
- [SurveyService_CreateSurveyFromTemplateRequest](/api-reference/schemas/surveyservice-createsurveyfromtemplaterequest-a1896e60e4.md): Fields: template_id, name, description, workspace_id, project_id, is_anonymous and 4 more.
- [SurveyService_CreateSurveyFromTemplateResponse](/api-reference/schemas/surveyservice-createsurveyfromtemplateresponse-3531509aa6.md): Fields: survey_id, name, template_id and created_at.
- [SurveyService_EnumeratorListResponse](/api-reference/schemas/surveyservice-enumeratorlistresponse-e7b82581a7.md): Field: enumerator_ids.
- [SurveyService_ExpressionValidationError](/api-reference/schemas/surveyservice-expressionvalidationerror-d772685b6f.md): A single validation error for expression validation.
- [SurveyService_ExpressionValidationRequest](/api-reference/schemas/surveyservice-expressionvalidationrequest-851259c810.md): Request body for expression validation endpoint.
- [SurveyService_ExpressionValidationResponse](/api-reference/schemas/surveyservice-expressionvalidationresponse-25d3eb1ba3.md): Response from expression validation endpoint.
- [SurveyService_FormAccessBulkCreate](/api-reference/schemas/surveyservice-formaccessbulkcreate-737da3f2db.md): Fields: user_ids, access_level, expires_at and assigned_triggers.
- [SurveyService_FormAccessCheckResponse](/api-reference/schemas/surveyservice-formaccesscheckresponse-3c494d433e.md): Fields: has_access, access_level, can_fill, can_view, can_approve, expires_at and 4 more.
- [SurveyService_FormAccessCreate](/api-reference/schemas/surveyservice-formaccesscreate-5aca3154b7.md): Fields: user_id, access_level, expires_at and assigned_triggers.
- [SurveyService_FormAccessLevel](/api-reference/schemas/surveyservice-formaccesslevel-a40adf7632.md): One of: fill, view_only and approver.
- [SurveyService_FormAccessListResponse](/api-reference/schemas/surveyservice-formaccesslistresponse-a2fac70f14.md): Fields: items, total, skip, limit, has_next and has_previous.
- [SurveyService_FormAccessResponse](/api-reference/schemas/surveyservice-formaccessresponse-0bba74834e.md): Fields: id, tenant_id, survey_id, user_id, granted_by, access_level and 6 more.
- [SurveyService_FormAccessRevokeRequest](/api-reference/schemas/surveyservice-formaccessrevokerequest-5db2d7647c.md): Field: reason.
- [SurveyService_FormAccessRevokeResponse](/api-reference/schemas/surveyservice-formaccessrevokeresponse-75f7697705.md): Fields: message, user_id, survey_id, grant_id, revoked_at, revoked_by and 1 more.
- [SurveyService_FormAccessUpdate](/api-reference/schemas/surveyservice-formaccessupdate-aeac9deb5f.md): Fields: access_level, expires_at and assigned_triggers.
- [SurveyService_FormAccessWithUserResponse](/api-reference/schemas/surveyservice-formaccesswithuserresponse-e26bd799f9.md): Fields: id, tenant_id, survey_id, user_id, granted_by, access_level and 12 more.
- [SurveyService_HTTPValidationError](/api-reference/schemas/surveyservice-httpvalidationerror-6237d5d2de.md): Field: detail.
- [SurveyService_HealthResponseDTO](/api-reference/schemas/surveyservice-healthresponsedto-c86ea40b0a.md): Health check response model.
- [SurveyService_HistoricalAccessCheckResponse](/api-reference/schemas/surveyservice-historicalaccesscheckresponse-cb621d4684.md): Fields: has_access, grant_id, access_level, created_at, revoked_at, revocation_reason and 1 more.
- [SurveyService_IssueCollectionGrantRequest](/api-reference/schemas/surveyservice-issuecollectiongrantrequest-c252488a8b.md): Fields: kind, user_id, survey_version_id, device_id, interview_id and schema_hash.
- [SurveyService_LanguageCreate](/api-reference/schemas/surveyservice-languagecreate-4380c928f6.md): Fields: code, name, flag_emoji, is_active and display_order.
- [SurveyService_LanguageListResponse](/api-reference/schemas/surveyservice-languagelistresponse-419045d5e5.md): Fields: languages and total.
- [SurveyService_LanguageReorderRequest](/api-reference/schemas/surveyservice-languagereorderrequest-0f3187190c.md): Field: language_ids.
- [SurveyService_LanguageResponse](/api-reference/schemas/surveyservice-languageresponse-316a38ba73.md): Fields: id, tenant_id, code, name, flag_emoji, is_active and 1 more.
- [SurveyService_LanguageUpdate](/api-reference/schemas/surveyservice-languageupdate-90b58bfe7e.md): Fields: code, name, flag_emoji, is_active and display_order.
- [SurveyService_LimitSchema](/api-reference/schemas/surveyservice-limitschema-6ae9a445e8.md): Limit configuration for text/number fields. For text: min/max character count For integer/decimal: min/max value
- [SurveyService_LookupConfigResponse](/api-reference/schemas/surveyservice-lookupconfigresponse-3484eec57a.md): Response model for lookup configuration.
- [SurveyService_LookupResolveRequest](/api-reference/schemas/surveyservice-lookupresolverequest-c77eea897e.md): Request model for lookup resolution.
- [SurveyService_LookupResolveResponse](/api-reference/schemas/surveyservice-lookupresolveresponse-6588d37db2.md): Response model for lookup resolution.
- [SurveyService_LookupResponse](/api-reference/schemas/surveyservice-lookupresponse-39d07f7a0a.md): Response model for lookup data
- [SurveyService_LookupSchema](/api-reference/schemas/surveyservice-lookupschema-8dcae41908.md): Lookup data item (custom lookups worksheet). Used for cascading selects and external data lookups.
- [SurveyService_LookupStatisticsResponse](/api-reference/schemas/surveyservice-lookupstatisticsresponse-8e3d62556a.md): Response model for lookup statistics.
- [SurveyService_LookupTriggerAssignment](/api-reference/schemas/surveyservice-lookuptriggerassignment-6b6e025c79.md): A single trigger value assignment for an enumerator.
- [SurveyService_LookupValidateRequest](/api-reference/schemas/surveyservice-lookupvalidaterequest-b7d8c64a9f.md): Request model for lookup validation.
- [SurveyService_LookupValidateResponse](/api-reference/schemas/surveyservice-lookupvalidateresponse-e2ef2d9f28.md): Response model for lookup validation.
- [SurveyService_QuestionBankCategoryCreate](/api-reference/schemas/surveyservice-questionbankcategorycreate-66976dcde6.md): Fields: name, description and color.
- [SurveyService_QuestionBankCategoryListResponse](/api-reference/schemas/surveyservice-questionbankcategorylistresponse-d9de2693ac.md): Fields: items, total, limit, skip, has_next and has_previous.
- [SurveyService_QuestionBankCategoryResponse](/api-reference/schemas/surveyservice-questionbankcategoryresponse-a375c670a2.md): Fields: id, tenant_id, name, description, color, question_count and 2 more.
- [SurveyService_QuestionBankCategoryUpdate](/api-reference/schemas/surveyservice-questionbankcategoryupdate-bdc6997037.md): Fields: name, description and color.
- [SurveyService_QuestionBulkImportResponse](/api-reference/schemas/surveyservice-questionbulkimportresponse-ccd59c5458.md): Fields: total, created, failed and errors.
- [SurveyService_QuestionCreate](/api-reference/schemas/surveyservice-questioncreate-32d6fe24cf.md): Fields: category_id, question_type, name, label, label_translations, hint and 5 more.
- [SurveyService_QuestionImportRowError](/api-reference/schemas/surveyservice-questionimportrowerror-f05a21fb87.md): Fields: row, field, code and message.
- [SurveyService_QuestionListResponse](/api-reference/schemas/surveyservice-questionlistresponse-76d583c41c.md): Fields: items, total, limit, skip, has_next and has_previous.
- [SurveyService_QuestionResponse](/api-reference/schemas/surveyservice-questionresponse-4b0eed1568.md): Fields: id, tenant_id, category_id, question_type, name, label and 13 more.
- [SurveyService_QuestionUpdate](/api-reference/schemas/surveyservice-questionupdate-77879266e2.md): Fields: category_id, label, label_translations, hint, hint_translations, required and 3 more.
- [SurveyService_SettingsSchema](/api-reference/schemas/surveyservice-settingsschema-c095279fef.md): Survey-level settings (XLSForm settings sheet)
- [SurveyService_SurveyAccessListResponse](/api-reference/schemas/surveyservice-surveyaccesslistresponse-2da76e8ef7.md): Fields: items, total, skip, limit, has_next and has_previous.
- [SurveyService_SurveyCreate](/api-reference/schemas/surveyservice-surveycreate-f6b9b7b4ee.md): Fields: name, description, workspace_id, project_id, is_anonymous, allow_multiple_responses and 4 more.
- [SurveyService_SurveyListResponse](/api-reference/schemas/surveyservice-surveylistresponse-6f76aa4818.md): Fields: items, total, limit, skip, has_next and has_previous.
- [SurveyService_SurveyQuestionResponse](/api-reference/schemas/surveyservice-surveyquestionresponse-2ea80a2a2b.md): Response model for question (mirrors SurveyQuestionSchema)
- [SurveyService_SurveyQuestionSchema](/api-reference/schemas/surveyservice-surveyquestionschema-900b06e530.md): XLSForm-compatible question schema. Supports all 22 question types with recursive nesting for groups/repeats.
- [SurveyService_SurveyQuestionType](/api-reference/schemas/surveyservice-surveyquestiontype-0845fbebf4.md): Complete XLSForm-compatible question types (KoboToolbox standard). Reference: https://xlsform.org/en/#question-types
- [SurveyService_SurveyResponse](/api-reference/schemas/surveyservice-surveyresponse-acaa084535.md): Fields: id, tenant_id, workspace_id, project_id, name, description and 17 more.
- [SurveyService_SurveyScheduleRequest](/api-reference/schemas/surveyservice-surveyschedulerequest-a75c775265.md): Fields: open_at, close_at and scheduling_enabled.
- [SurveyService_SurveySchema](/api-reference/schemas/surveyservice-surveyschema-bf82311926.md): Complete XLSForm-compatible survey schema. Stored in JSONB column in survey_versions table. Includes support for custom lookups worksheet for cascading selects.
- [SurveyService_SurveySchemaResponse](/api-reference/schemas/surveyservice-surveyschemaresponse-5750fea8e8.md): Response model for survey schema
- [SurveyService_SurveyStatus](/api-reference/schemas/surveyservice-surveystatus-aecdb8324e.md): One of: draft, published and archived.
- [SurveyService_SurveyStatusUpdate](/api-reference/schemas/surveyservice-surveystatusupdate-9af9f2648c.md): Field: status.
- [SurveyService_SurveyTagAssignment](/api-reference/schemas/surveyservice-surveytagassignment-054cc82606.md): Field: tag_ids.
- [SurveyService_SurveyTemplateCreate](/api-reference/schemas/surveyservice-surveytemplatecreate-a66802de32.md): Fields: name, description, schema, is_public, category_id and tenant_id.
- [SurveyService_SurveyTemplateDetailResponse](/api-reference/schemas/surveyservice-surveytemplatedetailresponse-127ad9735c.md): Fields: id, tenant_id, category_id, name, description, schema and 5 more.
- [SurveyService_SurveyTemplateListResponse](/api-reference/schemas/surveyservice-surveytemplatelistresponse-c54ef85c4c.md): Fields: items, total, limit, skip, has_next and has_previous.
- [SurveyService_SurveyTemplateResponse](/api-reference/schemas/surveyservice-surveytemplateresponse-3c9b6f0e45.md): Fields: id, tenant_id, category_id, name, description, schema and 5 more.
- [SurveyService_SurveyTemplateUpdate](/api-reference/schemas/surveyservice-surveytemplateupdate-afa2e05134.md): Fields: name, description, schema, category_id and is_public.
- [SurveyService_SurveyUpdate](/api-reference/schemas/surveyservice-surveyupdate-54c313a7cc.md): Fields: name, description, is_anonymous, allow_multiple_responses, open_at, close_at and 1 more.
- [SurveyService_SurveyVersionCreate](/api-reference/schemas/surveyservice-surveyversioncreate-18628b3dc4.md): DTO for creating a new survey version
- [SurveyService_SurveyVersionUpdate](/api-reference/schemas/surveyservice-surveyversionupdate-730f183650.md): DTO for updating a draft survey version (cannot update published).
- [SurveyService_SurveyWithAccessResponse](/api-reference/schemas/surveyservice-surveywithaccessresponse-13910afbb0.md): Fields: id, tenant_id, name, status, survey_code, version and 6 more.
- [SurveyService_TagCreate](/api-reference/schemas/surveyservice-tagcreate-17544066f2.md): Fields: name and color.
- [SurveyService_TagListResponse](/api-reference/schemas/surveyservice-taglistresponse-d30ebd816a.md): Fields: items and total.
- [SurveyService_TagResponse](/api-reference/schemas/surveyservice-tagresponse-1b11fe3a5a.md): Fields: id, tenant_id, name, color, created_at, updated_at and 1 more.
- [SurveyService_TagUpdate](/api-reference/schemas/surveyservice-tagupdate-526f8f866a.md): Fields: name and color.
- [SurveyService_TemplateCategoryCreate](/api-reference/schemas/surveyservice-templatecategorycreate-9d2165817d.md): Fields: name, description and icon_name.
- [SurveyService_TemplateCategoryListResponse](/api-reference/schemas/surveyservice-templatecategorylistresponse-5b69288fd0.md): Fields: items, total, limit, skip, has_next and has_previous.
- [SurveyService_TemplateCategoryResponse](/api-reference/schemas/surveyservice-templatecategoryresponse-01bb03f726.md): Fields: id, tenant_id, name, description, icon_name, created_at and 1 more.
- [SurveyService_TemplateCategoryUpdate](/api-reference/schemas/surveyservice-templatecategoryupdate-6f49019647.md): Fields: name, description and icon_name.
- [SurveyService_TemplateImportResponse](/api-reference/schemas/surveyservice-templateimportresponse-dc4e6cc7de.md): Fields: id, tenant_id, category_id, name, description, schema and 6 more.
- [SurveyService_TemplatesByCategoryResponse](/api-reference/schemas/surveyservice-templatesbycategoryresponse-211480a557.md): Fields: category, templates and template_count.
- [SurveyService_ValidateCollectionGrantResponse](/api-reference/schemas/surveyservice-validatecollectiongrantresponse-85d32170bf.md): Fields: valid, project_bound, grant_id, kind, survey_version_id, granted_at and 2 more.
- [SurveyService_ValidationError](/api-reference/schemas/surveyservice-validationerror-21d2a3258e.md): Fields: loc, msg, type, input and ctx.
- [DataService_AnalyticsSummaryDTO](/api-reference/schemas/dataservice-analyticssummarydto-f89f77fe05.md): Fields: survey_id, total_responses, unique_respondents, response_rate, average_completion_time_seconds, questions_analyzed and 1 more.
- [DataService_AnswerDistributionDTO](/api-reference/schemas/dataservice-answerdistributiondto-ec182b84a8.md): Fields: question_id, value, count and percentage.
- [DataService_ApprovalActionResponse](/api-reference/schemas/dataservice-approvalactionresponse-fc3f5095f9.md): Fields: success, message and response.
- [DataService_AttachmentDeleteResponse](/api-reference/schemas/dataservice-attachmentdeleteresponse-70c557fcbf.md): Fields: message and id.
- [DataService_AttachmentListDTO](/api-reference/schemas/dataservice-attachmentlistdto-1d811c8982.md): Fields: attachments, total, page and limit.
- [DataService_AttachmentRecordDTO](/api-reference/schemas/dataservice-attachmentrecorddto-a8c558619c.md): Fields: entity_type, entity_id, field_name, filename, original_filename, file_type and 6 more.
- [DataService_AttachmentResponseDTO](/api-reference/schemas/dataservice-attachmentresponsedto-d97d998c70.md): Fields: id, entity_type, entity_id, filename, original_filename, file_type and 11 more.
- [DataService_Body_generate_random_sample_api_v1_data_sampling_generate_post](/api-reference/schemas/dataservice-body-generate-random-sample-api-v1-data-sampling-generate-post-cfa6a9f524.md): Fields: file, sample_size and output_format.
- [DataService_Body_generate_random_sample_api_v1_sampling_generate_post](/api-reference/schemas/dataservice-body-generate-random-sample-api-v1-sampling-generate-post-3bd4a7c7c2.md): Fields: file, sample_size and output_format.
- [DataService_Body_upload_attachment_api_v1_attachments__post](/api-reference/schemas/dataservice-body-upload-attachment-api-v1-attachments-post-26b3416a69.md): Fields: entity_type, entity_id, description and file.
- [DataService_BulkApproveRequest](/api-reference/schemas/dataservice-bulkapproverequest-f8cbfdfa6b.md): Fields: survey_id, status, start_date, end_date, response_ids, dry_run and 1 more.
- [DataService_BulkDeleteRequest](/api-reference/schemas/dataservice-bulkdeleterequest-042aef6d19.md): Fields: survey_id, status, start_date, end_date, response_ids and dry_run.
- [DataService_BulkInvalidateRequest](/api-reference/schemas/dataservice-bulkinvalidaterequest-645d71b8e2.md): Fields: survey_id, status, start_date, end_date, response_ids, dry_run and 1 more.
- [DataService_BulkOperationResponseDTO](/api-reference/schemas/dataservice-bulkoperationresponsedto-213250aa8e.md): Fields: success_count, failure_count, skipped_count, errors and dry_run.
- [DataService_BulkResponseDTO](/api-reference/schemas/dataservice-bulkresponsedto-6186a6cba3.md): Field: responses.
- [DataService_BulkResponseItemDTO](/api-reference/schemas/dataservice-bulkresponseitemdto-815f063e10.md): Fields: idempotency_key, survey_id, version_id, respondent_id, answers, metadata and 1 more.
- [DataService_BulkResponseResultDTO](/api-reference/schemas/dataservice-bulkresponseresultdto-7fef7c2d2a.md): Fields: total, successful, failed and results.
- [DataService_BulkResponseResultItemDTO](/api-reference/schemas/dataservice-bulkresponseresultitemdto-1444f4952d.md): Fields: idempotency_key, response_id, status, error and submitted_at.
- [DataService_BulkUpdateStatusRequest](/api-reference/schemas/dataservice-bulkupdatestatusrequest-81e86f7c47.md): Fields: survey_id, status, start_date, end_date, response_ids, dry_run and 1 more.
- [DataService_DashboardMetricsDTO](/api-reference/schemas/dataservice-dashboardmetricsdto-e8c4c9ad5b.md): Fields: active_forms, active_enumerators, submissions_today, failed_submissions, latest_submission_times and timezone_context.
- [DataService_DuplicateGroupDto](/api-reference/schemas/dataservice-duplicategroupdto-569a80b84c.md): Fields: id, primary_response_id, duplicate_response_id, survey_id, confidence_score, criteria_breakdown and 4 more.
- [DataService_DuplicateGroupListDto](/api-reference/schemas/dataservice-duplicategrouplistdto-45925a02af.md): Fields: items, total, skip, limit, has_next and has_previous.
- [DataService_EnrichedAnswerDTO](/api-reference/schemas/dataservice-enrichedanswerdto-26018a4e78.md): Fields: question_id, question_type, value, value_json and presigned_url.
- [DataService_EnumeratorStatsDTO](/api-reference/schemas/dataservice-enumeratorstatsdto-770c9262e3.md): Fields: user_id, survey_id, total_submissions, total_rejected, rejection_rate, avg_duration_seconds and 6 more.
- [DataService_EnumeratorStatsListDTO](/api-reference/schemas/dataservice-enumeratorstatslistdto-6246a16b16.md): Fields: items, total, skip and limit.
- [DataService_ExportRequestDTO](/api-reference/schemas/dataservice-exportrequestdto-6e960894dd.md): Fields: survey_id, format, status, from_date, to_date, respondent_id and 4 more.
- [DataService_HTTPValidationError](/api-reference/schemas/dataservice-httpvalidationerror-2b62d4c031.md): Field: detail.
- [DataService_MediaExportStatusDTO](/api-reference/schemas/dataservice-mediaexportstatusdto-010ab9ea35.md): Fields: request_id, task_status, result and error.
- [DataService_MergeRequestDto](/api-reference/schemas/dataservice-mergerequestdto-552a15fd50.md): Fields: target_response_id, merge_note and conflict_resolutions.
- [DataService_MergeResponseDto](/api-reference/schemas/dataservice-mergeresponsedto-9a85c20cf5.md): Fields: success, primary_response_id, merged_response_id and message.
- [DataService_PendingApprovalCountDTO](/api-reference/schemas/dataservice-pendingapprovalcountdto-c52d4fc3f3.md): Fields: survey_id and count.
- [DataService_QuestionStatsDTO](/api-reference/schemas/dataservice-questionstatsdto-7c2abb2676.md): Fields: question_id, question_type, total_answers, unique_respondents, most_common_value and most_common_count.
- [DataService_ResponseApprovalRequest](/api-reference/schemas/dataservice-responseapprovalrequest-79fb6037db.md): Field: notes.
- [DataService_ResponseChangeDTO](/api-reference/schemas/dataservice-responsechangedto-8743e04bc7.md): A single response change. Deliberately carries no answer values.
- [DataService_ResponseChangeFeedDTO](/api-reference/schemas/dataservice-responsechangefeeddto-027825417d.md): Fields: items, next_watermark and has_more.
- [DataService_ResponseCorrectionRequest](/api-reference/schemas/dataservice-responsecorrectionrequest-cf62c1af2f.md): Enumerator correction of a rejected response.
- [DataService_ResponseCorrectionResponse](/api-reference/schemas/dataservice-responsecorrectionresponse-c28bcbc076.md): Fields: success, replayed, response_id, status, edit_id, edit_count and 2 more.
- [DataService_ResponseDTO](/api-reference/schemas/dataservice-responsedto-4965ff7816.md): Fields: id, survey_id, tenant_id, version_id, idempotency_key, interview_id and 37 more.
- [DataService_ResponseDetailDTO](/api-reference/schemas/dataservice-responsedetaildto-a1480d5392.md): Fields: id, survey_id, tenant_id, version_id, idempotency_key, interview_id and 38 more.
- [DataService_ResponseEditHistoryDTO](/api-reference/schemas/dataservice-responseedithistorydto-bc9831bff8.md): Fields: id, edited_at, edited_by, reason and changes_count.
- [DataService_ResponseEditHistoryListDTO](/api-reference/schemas/dataservice-responseedithistorylistdto-aea661769a.md): Fields: items and total.
- [DataService_ResponseEditRequest](/api-reference/schemas/dataservice-responseeditrequest-37984377ec.md): Fields: answers and reason.
- [DataService_ResponseEditResponse](/api-reference/schemas/dataservice-responseeditresponse-d2dbe15ff5.md): Fields: success, edit_id, response and changes_count.
- [DataService_ResponseListDTO](/api-reference/schemas/dataservice-responselistdto-2944fe7056.md): Fields: items, total, skip, limit, has_next and has_previous.
- [DataService_ResponseRejectionRequest](/api-reference/schemas/dataservice-responserejectionrequest-10039c1db0.md): Fields: reason and flags.
- [DataService_ResponseStatsDTO](/api-reference/schemas/dataservice-responsestatsdto-984232426a.md): Fields: survey_id, total_responses, draft_count, submitted_count, completed_count, invalidated_count and 4 more.
- [DataService_ResponseStatus](/api-reference/schemas/dataservice-responsestatus-e5ef0d2145.md): One of: draft, submitted, completed, invalidated, pending_approval, approved and 2 more.
- [DataService_ResponseValidationErrorDTO](/api-reference/schemas/dataservice-responsevalidationerrordto-bf8fbf8f8b.md): Fields: error and validation_errors.
- [DataService_ReviewFlag](/api-reference/schemas/dataservice-reviewflag-00bddaec6b.md): Fields: checked and note.
- [DataService_SimilarityMatch](/api-reference/schemas/dataservice-similaritymatch-1257ee54f6.md): Fields: response_id, confidence, criteria_breakdown and response_details.
- [DataService_SimilaritySearchRequest](/api-reference/schemas/dataservice-similaritysearchrequest-6164e6359c.md): Fields: survey_id, respondent_id, respondent_fields and gps_coordinates.
- [DataService_SimilaritySearchResponse](/api-reference/schemas/dataservice-similaritysearchresponse-f509f4699d.md): Fields: matches and total.
- [DataService_SubmitResponseDTO](/api-reference/schemas/dataservice-submitresponsedto-c283e9d365.md): Fields: survey_id, version_id, idempotency_key, respondent_id, answers, metadata and 12 more.
- [DataService_SurveyLatestSubmissionDTO](/api-reference/schemas/dataservice-surveylatestsubmissiondto-d34afcc8d1.md): Fields: survey_id, latest_submitted_at and latest_completed_at.
- [DataService_TimeSeriesDTO](/api-reference/schemas/dataservice-timeseriesdto-6c2dc9344e.md): Fields: survey_id, granularity and data.
- [DataService_TimeSeriesPointDTO](/api-reference/schemas/dataservice-timeseriespointdto-ffb25995cd.md): Fields: date and count.
- [DataService_UpdateAttachmentDTO](/api-reference/schemas/dataservice-updateattachmentdto-507e7c264d.md): Fields: description and field_name.
- [DataService_UpdateResponseDTO](/api-reference/schemas/dataservice-updateresponsedto-e633777d14.md): Fields: respondent_id, metadata and status.
- [DataService_UpdateReviewFlagsRequest](/api-reference/schemas/dataservice-updatereviewflagsrequest-58d53f9cf3.md): Field: flags.
- [DataService_ValidateIdsRequest](/api-reference/schemas/dataservice-validateidsrequest-e80f9a9107.md): Field: response_ids.
- [DataService_ValidateIdsResponse](/api-reference/schemas/dataservice-validateidsresponse-6025aa50ee.md): Field: valid_ids.
- [DataService_ValidationError](/api-reference/schemas/dataservice-validationerror-be7f37f547.md): Fields: loc, msg, type, input and ctx.
- [SyncService_BulkSyncPushRequestDTO](/api-reference/schemas/syncservice-bulksyncpushrequestdto-2e2a495459.md): Bulk push sync request.
- [SyncService_BulkSyncPushResponseDTO](/api-reference/schemas/syncservice-bulksyncpushresponsedto-256c360ea3.md): Bulk push sync response.
- [SyncService_ConflictDTO](/api-reference/schemas/syncservice-conflictdto-f94912064e.md): Sync conflict information.
- [SyncService_ConflictListDTO](/api-reference/schemas/syncservice-conflictlistdto-20ab3ce8f0.md): List of sync conflicts.
- [SyncService_ConflictResolutionRequestDTO](/api-reference/schemas/syncservice-conflictresolutionrequestdto-bad7c04c2f.md): Request to resolve a sync conflict.
- [SyncService_DeviceListDTO](/api-reference/schemas/syncservice-devicelistdto-ccfb481d80.md): List of devices response.
- [SyncService_DeviceRegistrationDTO](/api-reference/schemas/syncservice-deviceregistrationdto-e971e161c2.md): Device registration request.
- [SyncService_DeviceResponseDTO](/api-reference/schemas/syncservice-deviceresponsedto-e133ad3447.md): Device response.
- [SyncService_DeviceUpdateDTO](/api-reference/schemas/syncservice-deviceupdatedto-632de1793c.md): Device update request.
- [SyncService_FailedSubmissionsDTO](/api-reference/schemas/syncservice-failedsubmissionsdto-896a4a5dd6.md): Field: count.
- [SyncService_FormDownloadAcknowledgementDTO](/api-reference/schemas/syncservice-formdownloadacknowledgementdto-ad9119ecce.md): Client acknowledgement emitted only after a schema is persisted locally.
- [SyncService_HTTPValidationError](/api-reference/schemas/syncservice-httpvalidationerror-37f685d848.md): Field: detail.
- [SyncService_HealthResponseDTO](/api-reference/schemas/syncservice-healthresponsedto-697d0eceb2.md): Fields: status, service, version, timestamp and database.
- [SyncService_InitialSyncRequestDTO](/api-reference/schemas/syncservice-initialsyncrequestdto-46a37d29a1.md): Initial sync request.
- [SyncService_PushTokenUpdateDTO](/api-reference/schemas/syncservice-pushtokenupdatedto-43ffdcb755.md): Push token update request.
- [SyncService_ResponseAnswerDTO](/api-reference/schemas/syncservice-responseanswerdto-61c896b1aa.md): Response answer data.
- [SyncService_RoleSyncDTO](/api-reference/schemas/syncservice-rolesyncdto-f46d7e73d8.md): Role and permissions descriptor for sync pull response.
- [SyncService_SurveySyncDTO](/api-reference/schemas/syncservice-surveysyncdto-2daae3b3af.md): Survey sync data — a descriptor, not a content channel (D-11).
- [SyncService_SyncMetadataDTO](/api-reference/schemas/syncservice-syncmetadatadto-dec4bd83a0.md): Sync metadata response.
- [SyncService_SyncPullRequestDTO](/api-reference/schemas/syncservice-syncpullrequestdto-a513103abd.md): Pull sync request.
- [SyncService_SyncPullResponseDTO](/api-reference/schemas/syncservice-syncpullresponsedto-9180ff81cc.md): Pull sync response.
- [SyncService_SyncPushRequestDTO](/api-reference/schemas/syncservice-syncpushrequestdto-7adf1d0ea0.md): Push sync request for single response.
- [SyncService_SyncPushResponseDTO](/api-reference/schemas/syncservice-syncpushresponsedto-4f0c60b804.md): Push sync response.
- [SyncService_SyncReconciliationRequestDTO](/api-reference/schemas/syncservice-syncreconciliationrequestdto-1c0ada8e5e.md): Server-authorized reconciliation request for responses predating access revocation (R17 & R22).
- [SyncService_SyncReconciliationResponseDTO](/api-reference/schemas/syncservice-syncreconciliationresponsedto-207ca37ffc.md): Server-authorized reconciliation response.
- [SyncService_SyncStatusDTO](/api-reference/schemas/syncservice-syncstatusdto-ca2dadecbc.md): Sync status response.
- [SyncService_ValidationError](/api-reference/schemas/syncservice-validationerror-74e4de623a.md): Fields: loc, msg, type, input and ctx.
- [AnalyticsService_AggregateDataPointDTO](/api-reference/schemas/analyticsservice-aggregatedatapointdto-30c0651c6d.md): Single data point in aggregated results.
- [AnalyticsService_AggregateRequestDTO](/api-reference/schemas/analyticsservice-aggregaterequestdto-7d8b8a40a5.md): Request to aggregate survey response data for a chart panel.
- [AnalyticsService_AggregateResponseDTO](/api-reference/schemas/analyticsservice-aggregateresponsedto-1f3e009075.md): Aggregated chart data response.
- [AnalyticsService_AnalyticsResponseListDTO](/api-reference/schemas/analyticsservice-analyticsresponselistdto-ce7ca15f9c.md): Paginated list of survey responses for analytics.
- [AnalyticsService_AnalyticsSummaryDTO](/api-reference/schemas/analyticsservice-analyticssummarydto-ee32276bd2.md): Analytics summary.
- [AnalyticsService_CreateDashboardDTO](/api-reference/schemas/analyticsservice-createdashboarddto-018b6dd91e.md): Create dashboard request.
- [AnalyticsService_CreateWidgetDTO](/api-reference/schemas/analyticsservice-createwidgetdto-a1a87edd85.md): Create widget request.
- [AnalyticsService_DashboardListDTO](/api-reference/schemas/analyticsservice-dashboardlistdto-55951fb19f.md): Fields: items, total, skip, limit, has_next and has_previous.
- [AnalyticsService_DashboardResponseDTO](/api-reference/schemas/analyticsservice-dashboardresponsedto-2b81aef221.md): Dashboard response.
- [AnalyticsService_DashboardSummaryDTO](/api-reference/schemas/analyticsservice-dashboardsummarydto-50102923ed.md): Dashboard summary metrics.
- [AnalyticsService_GenerateDashboardRequestDTO](/api-reference/schemas/analyticsservice-generatedashboardrequestdto-c331f9ce2f.md): Request to generate a default dashboard for a survey.
- [AnalyticsService_GenerateDashboardResponseDTO](/api-reference/schemas/analyticsservice-generatedashboardresponsedto-b154c93bb2.md): Response from dashboard generation.
- [AnalyticsService_HTTPValidationError](/api-reference/schemas/analyticsservice-httpvalidationerror-f43c0b92b8.md): Field: detail.
- [AnalyticsService_ResponseMetricsDTO](/api-reference/schemas/analyticsservice-responsemetricsdto-97442b3e66.md): Response metrics for a date range.
- [AnalyticsService_SurveyAnalyticsDTO](/api-reference/schemas/analyticsservice-surveyanalyticsdto-eaa15f0945.md): Survey analytics.
- [AnalyticsService_SurveyPerformanceDTO](/api-reference/schemas/analyticsservice-surveyperformancedto-8ee7c2d09d.md): Survey performance metrics.
- [AnalyticsService_UpdateDashboardDTO](/api-reference/schemas/analyticsservice-updatedashboarddto-c21889ac74.md): Update dashboard request.
- [AnalyticsService_UpdateWidgetDTO](/api-reference/schemas/analyticsservice-updatewidgetdto-cdf10a9b61.md): Update widget request.
- [AnalyticsService_ValidationError](/api-reference/schemas/analyticsservice-validationerror-190b0412bc.md): Fields: loc, msg, type, input and ctx.
- [AnalyticsService_WidgetDataDTO](/api-reference/schemas/analyticsservice-widgetdatadto-751ea0fa5f.md): Widget data response.
- [AnalyticsService_WidgetResponseDTO](/api-reference/schemas/analyticsservice-widgetresponsedto-2c5efd8617.md): Widget response.
- [WorkspaceService_HTTPValidationError](/api-reference/schemas/workspaceservice-httpvalidationerror-92a261e7a3.md): Field: detail.
- [WorkspaceService_HealthResponseDTO](/api-reference/schemas/workspaceservice-healthresponsedto-c0e9b591bf.md): Fields: status, service, version and timestamp.
- [WorkspaceService_MemberAddDTO](/api-reference/schemas/workspaceservice-memberadddto-46f3ade998.md): Fields: user_id and role.
- [WorkspaceService_MemberListDTO](/api-reference/schemas/workspaceservice-memberlistdto-fe1eb49881.md): Fields: items, total, skip, limit, has_next and has_previous.
- [WorkspaceService_MemberResponseDTO](/api-reference/schemas/workspaceservice-memberresponsedto-e53a9b7ac0.md): Fields: id, workspace_id, user_id, tenant_id, role, invited_by and 5 more.
- [WorkspaceService_MemberUpdateDTO](/api-reference/schemas/workspaceservice-memberupdatedto-f0ab1bb005.md): Field: role.
- [WorkspaceService_ProjectCreateDTO](/api-reference/schemas/workspaceservice-projectcreatedto-e7bed61243.md): Fields: name and description.
- [WorkspaceService_ProjectListDTO](/api-reference/schemas/workspaceservice-projectlistdto-a0f0daa6c6.md): Fields: items, total, skip, limit, has_next and has_previous.
- [WorkspaceService_ProjectResponseDTO](/api-reference/schemas/workspaceservice-projectresponsedto-4a7146f3a1.md): Fields: id, workspace_id, tenant_id, name, description, status and 5 more.
- [WorkspaceService_ProjectStatus](/api-reference/schemas/workspaceservice-projectstatus-d27a31ff2e.md): One of: draft, active, completed, archived and deleted.
- [WorkspaceService_ProjectUpdateDTO](/api-reference/schemas/workspaceservice-projectupdatedto-f68dedb1d5.md): Fields: name, description and status.
- [WorkspaceService_ValidationError](/api-reference/schemas/workspaceservice-validationerror-9662acef93.md): Fields: loc, msg, type, input and ctx.
- [WorkspaceService_WorkspaceCreateDTO](/api-reference/schemas/workspaceservice-workspacecreatedto-a1f26cbaf5.md): Fields: name and description.
- [WorkspaceService_WorkspaceListDTO](/api-reference/schemas/workspaceservice-workspacelistdto-f350822239.md): Fields: items, total, skip, limit, has_next and has_previous.
- [WorkspaceService_WorkspaceMemberRole](/api-reference/schemas/workspaceservice-workspacememberrole-c3d06b523e.md): One of: owner, admin, editor, viewer and responder.
- [WorkspaceService_WorkspaceResponseDTO](/api-reference/schemas/workspaceservice-workspaceresponsedto-4de4578a77.md): Fields: id, tenant_id, name, description, status, created_at and 2 more.
- [WorkspaceService_WorkspaceStatus](/api-reference/schemas/workspaceservice-workspacestatus-652b9c3598.md): One of: active, archived, suspended and deleted.
- [WorkspaceService_WorkspaceUpdateDTO](/api-reference/schemas/workspaceservice-workspaceupdatedto-67c3d9a327.md): Fields: name, description and status.
- [WebhookService_CreateSubscriptionDTO](/api-reference/schemas/webhookservice-createsubscriptiondto-5be2bbdf3a.md): DTO for creating a webhook subscription.
- [WebhookService_DeliveryListDTO](/api-reference/schemas/webhookservice-deliverylistdto-0b5fb8ee1b.md): DTO for list of webhook deliveries.
- [WebhookService_DeliveryResponseDTO](/api-reference/schemas/webhookservice-deliveryresponsedto-6b960b3b2e.md): DTO for webhook delivery response.
- [WebhookService_HTTPValidationError](/api-reference/schemas/webhookservice-httpvalidationerror-119a4c7db4.md): Field: detail.
- [WebhookService_SubscriptionListDTO](/api-reference/schemas/webhookservice-subscriptionlistdto-96134a4012.md): DTO for list of webhook subscriptions.
- [WebhookService_SubscriptionResponseDTO](/api-reference/schemas/webhookservice-subscriptionresponsedto-ad3230cd18.md): DTO for webhook subscription response.
- [WebhookService_UpdateSubscriptionDTO](/api-reference/schemas/webhookservice-updatesubscriptiondto-65db636053.md): DTO for updating a webhook subscription.
- [WebhookService_ValidationError](/api-reference/schemas/webhookservice-validationerror-f46d3ea8f8.md): Fields: loc, msg, type, input and ctx.
- [OdkBridge_Body_submit_form_submission_post](/api-reference/schemas/odkbridge-body-submit-form-submission-post-dde00f2180.md): Fields: xml_submission_file and attachments.
- [OdkBridge_HTTPValidationError](/api-reference/schemas/odkbridge-httpvalidationerror-4a5630f462.md): Field: detail.
- [OdkBridge_ValidationError](/api-reference/schemas/odkbridge-validationerror-b831ec1b45.md): Fields: loc, msg, type, input and ctx.
- [FormService_BatchNoteCreateDto](/api-reference/schemas/formservice-batchnotecreatedto-4f9402d4a9.md): Field: notes.
- [FormService_CreateInterviewDto](/api-reference/schemas/formservice-createinterviewdto-1a4f776587.md): Fields: survey_id, respondent_id, session_token, total_questions, language, interview_metadata and 2 more.
- [FormService_DraftConflictResponse](/api-reference/schemas/formservice-draftconflictresponse-f49b85967c.md): Response returned upon an optimistic concurrency conflict (HTTP 409).
- [FormService_DraftCreateRequest](/api-reference/schemas/formservice-draftcreaterequest-2050464672.md): Request to create a new draft.
- [FormService_DraftDeltaResponse](/api-reference/schemas/formservice-draftdeltaresponse-f5752cb6b2.md): Response containing delta sync drafts since cursor.
- [FormService_DraftDrainRevokedRequest](/api-reference/schemas/formservice-draftdrainrevokedrequest-57a2cef442.md): Request to drain an offline draft whose user's assignment was revoked.
- [FormService_DraftListResponse](/api-reference/schemas/formservice-draftlistresponse-4e547f5e89.md): Response containing list of drafts.
- [FormService_DraftResponse](/api-reference/schemas/formservice-draftresponse-11a8f6ea0f.md): Response containing draft information.
- [FormService_DraftUpdateRequest](/api-reference/schemas/formservice-draftupdaterequest-fea029a037.md): Request to update an existing draft.
- [FormService_EvaluateExpressionRequest](/api-reference/schemas/formservice-evaluateexpressionrequest-35ddfa78e2.md): Request to evaluate an XPath expression.
- [FormService_EvaluateExpressionResponse](/api-reference/schemas/formservice-evaluateexpressionresponse-61ee13f101.md): Response for expression evaluation.
- [FormService_FormManifestResponse](/api-reference/schemas/formservice-formmanifestresponse-e9f3bc0837.md): Response for offline form manifest.
- [FormService_FormRenderResponse](/api-reference/schemas/formservice-formrenderresponse-6f753a5814.md): Response containing rendered form data.
- [FormService_FormSubmitRequest](/api-reference/schemas/formservice-formsubmitrequest-2d8b5b44e8.md): Request to submit a completed form.
- [FormService_FormSubmitResponse](/api-reference/schemas/formservice-formsubmitresponse-23adf0d549.md): Response after form submission.
- [FormService_FormValidateRequest](/api-reference/schemas/formservice-formvalidaterequest-a151812b3b.md): Request to validate form data without submitting.
- [FormService_FormValidateResponse](/api-reference/schemas/formservice-formvalidateresponse-394c496878.md): Response with validation results.
- [FormService_HTTPValidationError](/api-reference/schemas/formservice-httpvalidationerror-8e8725ba52.md): Field: detail.
- [FormService_InterviewDto](/api-reference/schemas/formservice-interviewdto-8f3906253b.md): Fields: id, tenant_id, survey_id, respondent_id, interviewer_id, session_id and 19 more.
- [FormService_InterviewEventDto](/api-reference/schemas/formservice-intervieweventdto-9b738f45ed.md): Fields: id, interview_id, tenant_id, from_status, to_status, triggered_by and 2 more.
- [FormService_InterviewListResponse](/api-reference/schemas/formservice-interviewlistresponse-7153ae680b.md): Fields: items, total, skip, limit, has_next and has_previous.
- [FormService_NoteCreateDto](/api-reference/schemas/formservice-notecreatedto-1d46b029fa.md): Fields: field_name, text, category and client_created_at.
- [FormService_NoteListResponse](/api-reference/schemas/formservice-notelistresponse-ff5f1d209b.md): Fields: items and total.
- [FormService_NoteResponseDto](/api-reference/schemas/formservice-noteresponsedto-705fa67267.md): Fields: id, interview_id, tenant_id, field_name, text, category and 5 more.
- [FormService_NoteUpdateDto](/api-reference/schemas/formservice-noteupdatedto-caba699aea.md): Fields: text, category, pinned and field_name.
- [FormService_PrefillResponse](/api-reference/schemas/formservice-prefillresponse-9b65bda96c.md): Response containing pre-fill data from a previous response.
- [FormService_RidBlockAllocationRequest](/api-reference/schemas/formservice-ridblockallocationrequest-0933e80022.md): Request payload for server-allocated device-bound RID block (R25 / AD-3).
- [FormService_RidBlockListResponse](/api-reference/schemas/formservice-ridblocklistresponse-2b9b9da213.md): List of RID block allocations.
- [FormService_RidBlockResponse](/api-reference/schemas/formservice-ridblockresponse-4b8c100a7a.md): Server-allocated device-bound RID block response (matches mobile RidBlockDto).
- [FormService_SessionListResponse](/api-reference/schemas/formservice-sessionlistresponse-1fe9e0e8ce.md): Response containing list of sessions.
- [FormService_SessionResponse](/api-reference/schemas/formservice-sessionresponse-11edd23d9f.md): Response containing session information.
- [FormService_TerminationDto](/api-reference/schemas/formservice-terminationdto-827fa97c4f.md): Fields: id, interview_id, tenant_id, termination_reason, explanatory_text, retain_partial_data and 7 more.
- [FormService_TerminationPolicyDto](/api-reference/schemas/formservice-terminationpolicydto-d1fa53cfd0.md): Fields: retain_partial_data, discard_data, notify_supervisor and requires_explanatory_text.
- [FormService_TerminationReasonOptionDto](/api-reference/schemas/formservice-terminationreasonoptiondto-880f57b551.md): Fields: code, display_label and policy.
- [FormService_TransitionInterviewDto](/api-reference/schemas/formservice-transitioninterviewdto-c26435a1a1.md): Fields: to_status, termination_reason, explanatory_text, form_data, is_complete, current_page and 4 more.
- [FormService_UpdateInterviewDto](/api-reference/schemas/formservice-updateinterviewdto-c7d9ace9ae.md): Fields: respondent_id, current_page, answered_count, total_questions and interview_metadata.
- [FormService_ValidateFieldRequest](/api-reference/schemas/formservice-validatefieldrequest-fee5567ddf.md): Request to validate a single field.
- [FormService_ValidateFieldResponse](/api-reference/schemas/formservice-validatefieldresponse-6baa72e46e.md): Response for single field validation.
- [FormService_ValidateFormRequest](/api-reference/schemas/formservice-validateformrequest-844286fc55.md): Request to validate entire form.
- [FormService_ValidateFormResponse](/api-reference/schemas/formservice-validateformresponse-957dec06ed.md): Response for form validation.
- [FormService_ValidationError](/api-reference/schemas/formservice-validationerror-e235b81cf9.md): Fields: loc, msg, type, input and ctx.
- [MediaService_AssetUpdateRequest](/api-reference/schemas/mediaservice-assetupdaterequest-5a8ce499c3.md): Fields: original_filename, description, alt_text, tags and is_public.
- [MediaService_Body_upload_batch_api_v1_media_upload_batch_post](/api-reference/schemas/mediaservice-body-upload-batch-api-v1-media-upload-batch-post-5ea4e742e9.md): Fields: files, survey_id, response_id, entity_type, entity_id, user_name and 1 more.
- [MediaService_Body_upload_chunk_api_v1_media_upload_chunk_post](/api-reference/schemas/mediaservice-body-upload-chunk-api-v1-media-upload-chunk-post-3d429bec17.md): Fields: file, upload_id, chunk_index, total_chunks, file_name, mime_type and 4 more.
- [MediaService_Body_upload_file_api_v1_media_upload_post](/api-reference/schemas/mediaservice-body-upload-file-api-v1-media-upload-post-e04daaccb8.md): Fields: file, survey_id, response_id, entity_type, entity_id, is_public and 6 more.
- [MediaService_Body_upload_library_file_api_v1_media_library_upload_post](/api-reference/schemas/mediaservice-body-upload-library-file-api-v1-media-library-upload-post-dbd2f63f47.md): Fields: file, description, survey_name, question_name and response_id.
- [MediaService_Body_upload_library_files_batch_api_v1_media_library_upload_batch_post](/api-reference/schemas/mediaservice-body-upload-library-files-batch-api-v1-media-library-upload-batch-post-352912a6cf.md): Field: files.
- [MediaService_HTTPValidationError](/api-reference/schemas/mediaservice-httpvalidationerror-f5812c7c1f.md): Field: detail.
- [MediaService_ValidationError](/api-reference/schemas/mediaservice-validationerror-0fc30c3898.md): Fields: loc, msg, type, input and ctx.
- [NotificationService_AWSConfig](/api-reference/schemas/notificationservice-awsconfig-00d0034632.md): Fields: aws_region, aws_access_key_id, aws_secret_access_key and aws_origination_number.
- [NotificationService_AWSConfigResponse](/api-reference/schemas/notificationservice-awsconfigresponse-e8c66a5507.md): Fields: aws_region, aws_access_key_id, aws_secret_access_key and aws_origination_number.
- [NotificationService_AfricasTalkingConfig](/api-reference/schemas/notificationservice-africastalkingconfig-fb71dc718d.md): Fields: africas_talking_username, africas_talking_api_key and africas_talking_shortcode.
- [NotificationService_AfricasTalkingConfigResponse](/api-reference/schemas/notificationservice-africastalkingconfigresponse-171e3c21dd.md): Fields: africas_talking_username, africas_talking_api_key and africas_talking_shortcode.
- [NotificationService_CancelNotificationsRequest](/api-reference/schemas/notificationservice-cancelnotificationsrequest-2d6a11dc16.md): Field: recipient.
- [NotificationService_GenericHttpConfig](/api-reference/schemas/notificationservice-generichttpconfig-61cc58e557.md): Fields: generic_sms_endpoint, generic_sms_method, generic_sms_auth_header_name, generic_sms_auth_header_value and generic_sms_body_template.
- [NotificationService_GenericHttpConfigResponse](/api-reference/schemas/notificationservice-generichttpconfigresponse-c12cbab716.md): Fields: generic_sms_endpoint, generic_sms_method, generic_sms_auth_header_name, generic_sms_auth_header_value and generic_sms_body_template.
- [NotificationService_HTTPValidationError](/api-reference/schemas/notificationservice-httpvalidationerror-89b24df40a.md): Field: detail.
- [NotificationService_KaleyraConfig](/api-reference/schemas/notificationservice-kaleyraconfig-a61cec99b1.md): Fields: kaleyra_api_key, kaleyra_account_sid and kaleyra_sender_id.
- [NotificationService_KaleyraConfigResponse](/api-reference/schemas/notificationservice-kaleyraconfigresponse-d7f645b660.md): Fields: kaleyra_api_key, kaleyra_account_sid and kaleyra_sender_id.
- [NotificationService_MSG91Config](/api-reference/schemas/notificationservice-msg91config-e074ce88a5.md): Fields: msg91_api_key, msg91_sender_id, msg91_flow_id and msg91_route.
- [NotificationService_MSG91ConfigResponse](/api-reference/schemas/notificationservice-msg91configresponse-f9524e204e.md): Fields: msg91_api_key, msg91_sender_id, msg91_flow_id and msg91_route.
- [NotificationService_NotificationSettingsRequest](/api-reference/schemas/notificationservice-notificationsettingsrequest-0dbf9180a6.md): Fields: smtp, sms_provider, aws, twilio, msg91, kaleyra and 3 more.
- [NotificationService_NotificationSettingsResponse](/api-reference/schemas/notificationservice-notificationsettingsresponse-6aa4babdfd.md): Fields: sms_provider, smtp, aws, twilio, msg91, kaleyra and 6 more.
- [NotificationService_NotificationType](/api-reference/schemas/notificationservice-notificationtype-26f3121586.md): One of: account_activation, password_reset_request, password_changed, email_change_confirmation, email_changed_notify, magic_link_login and 6 more.
- [NotificationService_SMTPConfig](/api-reference/schemas/notificationservice-smtpconfig-da6804e9b9.md): Fields: smtp_host, smtp_port, smtp_username, smtp_password, smtp_from_email, smtp_from_name and 1 more.
- [NotificationService_SMTPConfigResponse](/api-reference/schemas/notificationservice-smtpconfigresponse-cf5f60ea60.md): Fields: smtp_host, smtp_port, smtp_username, smtp_password, smtp_from_email, smtp_from_name and 1 more.
- [NotificationService_SendBatchRequest](/api-reference/schemas/notificationservice-sendbatchrequest-adadffcaa6.md): Field: notifications.
- [NotificationService_SendNotificationRequest](/api-reference/schemas/notificationservice-sendnotificationrequest-bce0cd0fcb.md): Fields: channel, recipient, subject, body, template_id, template_vars and 3 more.
- [NotificationService_SlackConfig](/api-reference/schemas/notificationservice-slackconfig-3aeb3a316e.md): Field: slack_webhook_url.
- [NotificationService_SlackConfigResponse](/api-reference/schemas/notificationservice-slackconfigresponse-2b5dd208e8.md): Field: slack_webhook_url.
- [NotificationService_TemplateCreateRequest](/api-reference/schemas/notificationservice-templatecreaterequest-9d73ece643.md): Fields: name, channel, subject_template, body_template and variables.
- [NotificationService_TemplateLivePreviewRequest](/api-reference/schemas/notificationservice-templatelivepreviewrequest-62dac37c00.md): Fields: subject_template, body_template and variables.
- [NotificationService_TemplatePreviewRequest](/api-reference/schemas/notificationservice-templatepreviewrequest-8be7d0806f.md): Field: variables.
- [NotificationService_TemplateUpdateRequest](/api-reference/schemas/notificationservice-templateupdaterequest-17499a4752.md): Fields: name, subject_template, body_template, variables and is_active.
- [NotificationService_TestNotificationRequest](/api-reference/schemas/notificationservice-testnotificationrequest-182b6121fa.md): Fields: channel, recipient, subject and body.
- [NotificationService_TwilioConfig](/api-reference/schemas/notificationservice-twilioconfig-b3f84254c5.md): Fields: twilio_account_sid, twilio_auth_token and twilio_from_number.
- [NotificationService_TwilioConfigResponse](/api-reference/schemas/notificationservice-twilioconfigresponse-ca0345efeb.md): Fields: twilio_account_sid, twilio_auth_token and twilio_from_number.
- [NotificationService_UserPreferenceRequest](/api-reference/schemas/notificationservice-userpreferencerequest-3b9c7441ee.md): Fields: channel, is_enabled, quiet_hours_start, quiet_hours_end and frequency.
- [NotificationService_ValidationError](/api-reference/schemas/notificationservice-validationerror-e6abc27f21.md): Fields: loc, msg, type, input and ctx.
- [AuditService_AuditLogCreateRequest](/api-reference/schemas/auditservice-auditlogcreaterequest-190eafb833.md): Fields: event_id, event_type, log_schema_version, service_name, action, actor_type and 26 more.
- [AuditService_AuditLogListResponse](/api-reference/schemas/auditservice-auditloglistresponse-2c9c70a444.md): Fields: items, total, skip, limit, has_next and has_previous.
- [AuditService_AuditLogResponse](/api-reference/schemas/auditservice-auditlogresponse-a136345fdc.md): Fields: id, event_id, event_type, log_schema_version, service_name, action and 28 more.
- [AuditService_ConsentRecordRequest](/api-reference/schemas/auditservice-consentrecordrequest-5e6c8467ca.md): Fields: user_id, consent_type, is_granted, ip_address and metadata.
- [AuditService_ConsentRecordResponse](/api-reference/schemas/auditservice-consentrecordresponse-e946da96db.md): Fields: id, user_id, consent_type, is_granted, granted_at, revoked_at and 1 more.
- [AuditService_HTTPValidationError](/api-reference/schemas/auditservice-httpvalidationerror-3f968f5485.md): Field: detail.
- [AuditService_ValidationError](/api-reference/schemas/auditservice-validationerror-e7f58675b6.md): Fields: loc, msg, type, input and ctx.
- [FeatureFlagsService_BatchEvaluateRequest](/api-reference/schemas/featureflagsservice-batchevaluaterequest-49691e6feb.md): Field: flags.
- [FeatureFlagsService_BatchEvaluateResponse](/api-reference/schemas/featureflagsservice-batchevaluateresponse-947d9945a9.md): Field: results.
- [FeatureFlagsService_EntitlementCatalogueItem](/api-reference/schemas/featureflagsservice-entitlementcatalogueitem-00de5604a9.md): Fields: key, source_key, name, type, unit, category and 11 more.
- [FeatureFlagsService_EntitlementCatalogueResponse](/api-reference/schemas/featureflagsservice-entitlementcatalogueresponse-db77f3cc05.md): Field: items.
- [FeatureFlagsService_EvaluateRequest](/api-reference/schemas/featureflagsservice-evaluaterequest-7fe3d20a3e.md): Fields: flag_key and context.
- [FeatureFlagsService_EvaluateResponse](/api-reference/schemas/featureflagsservice-evaluateresponse-67c5746a2d.md): Fields: flag_key, value, is_enabled and matched_rule.
- [FeatureFlagsService_FlagCreateRequest](/api-reference/schemas/featureflagsservice-flagcreaterequest-7e586dac33.md): Fields: key, name, description, flag_type, default_value, is_enabled and 4 more.
- [FeatureFlagsService_FlagListResponse](/api-reference/schemas/featureflagsservice-flaglistresponse-3b98034a38.md): Fields: items, total, skip, limit, has_next and has_previous.
- [FeatureFlagsService_FlagResponse](/api-reference/schemas/featureflagsservice-flagresponse-0b1ca4f946.md): Fields: id, key, name, description, flag_type, default_value and 9 more.
- [FeatureFlagsService_FlagUpdateRequest](/api-reference/schemas/featureflagsservice-flagupdaterequest-57720e5cb6.md): Fields: name, description, default_value, is_enabled, tags, plan_tier and 1 more.
- [FeatureFlagsService_HTTPValidationError](/api-reference/schemas/featureflagsservice-httpvalidationerror-323f73e647.md): Field: detail.
- [FeatureFlagsService_HealthResponseDTO](/api-reference/schemas/featureflagsservice-healthresponsedto-bf7b7ed0b2.md): Health check response model.
- [FeatureFlagsService_InvalidateResponse](/api-reference/schemas/featureflagsservice-invalidateresponse-0a5b67a609.md): Fields: tenant_id, invalidated and message.
- [FeatureFlagsService_LimitItem](/api-reference/schemas/featureflagsservice-limititem-03bc0c04f8.md): Fields: key, canonical_key, name, value, category, scope and 3 more.
- [FeatureFlagsService_PlanDto](/api-reference/schemas/featureflagsservice-plandto-c31934468f.md): Fields: id, name, description, price_id, amount, currency and 3 more.
- [FeatureFlagsService_PlanFeatureDto](/api-reference/schemas/featureflagsservice-planfeaturedto-afc9543684.md): Fields: key, canonical_key, name, description, flag_type, value and 6 more.
- [FeatureFlagsService_PlanLimitDto](/api-reference/schemas/featureflagsservice-planlimitdto-e61d1af0e6.md): Fields: key, canonical_key, name, value, category, scope and 9 more.
- [FeatureFlagsService_PlanListResponse](/api-reference/schemas/featureflagsservice-planlistresponse-627f656d5c.md): Field: items.
- [FeatureFlagsService_TenantEntitlementsResponse](/api-reference/schemas/featureflagsservice-tenantentitlementsresponse-e6fe4f0451.md): Fields: tenant_id, tier, subscription_status, active, trial, trial_end_at and 3 more.
- [FeatureFlagsService_TenantFeaturesResponse](/api-reference/schemas/featureflagsservice-tenantfeaturesresponse-5556aaa956.md): Fields: items and tier.
- [FeatureFlagsService_TenantLimitsResponse](/api-reference/schemas/featureflagsservice-tenantlimitsresponse-29dca159bc.md): Fields: items, tier and tenant_id.
- [FeatureFlagsService_ValidationError](/api-reference/schemas/featureflagsservice-validationerror-8a86fa3019.md): Fields: loc, msg, type, input and ctx.
- [QuotaService_CheckLimitRequest](/api-reference/schemas/quotaservice-checklimitrequest-07b483f81a.md): Request to check quota availability.
- [QuotaService_ConsumeQuotaRequest](/api-reference/schemas/quotaservice-consumequotarequest-18a33820bc.md): Request to consume quota.
- [QuotaService_HTTPValidationError](/api-reference/schemas/quotaservice-httpvalidationerror-ee21a36cae.md): Field: detail.
- [QuotaService_QuotaResponse](/api-reference/schemas/quotaservice-quotaresponse-8cc523fb43.md): Response from quota operations.
- [QuotaService_RollbackRequest](/api-reference/schemas/quotaservice-rollbackrequest-c6f2bbc3ff.md): Request to rollback quota.
- [QuotaService_ValidationError](/api-reference/schemas/quotaservice-validationerror-b3c616c755.md): Fields: loc, msg, type, input and ctx.