Build on the IndeForms platform.
Integrate IndeForms into your ecosystem. Every form, dispatch, submission, and workflow action is available via authenticated REST endpoints.
Backward-compatible deprecations announced 90 days in advance. Tokens scoped to your account. Audited end-to-end.
Base URL
/api/admin
Authentication
Bearer <JWT>
Format
JSON
Mobile API
/api/client
Forms
Create, list, publish, clone, and manage the full form lifecycle including AI-powered paper-to-digital conversion.
POST/form-builder/forms/getAllForms
Retrieve all forms with pagination, search, and sort
Retrieve all forms with pagination, search, and sort filters.
application/json{
"page": 1,
"limit": 20,
"search": "Daily",
"sortBy": "modified_on",
"sortOrder": "desc"
}POST/form-builder/forms/create
Create a new form with initial page and section
Create a new form with an initial page and section.
application/json{
"form_name": "Daily Inspection"
}POST/form-builder/forms/publish
Publish a form version, freezes structure and rules
Publish a form version — freezes structure, rules, and options into a versioned snapshot.
application/json{
"form_base_id": 0
}POST/form-builder/forms/clone
Clone an existing form including structure, rules, and options
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/forms/changeStatus
Activate or deactivate a form
Detailed schema coming soon. Refer to the endpoint description above.
DELETE/form-builder/forms/delete
Permanently delete a form and all related data
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/forms/from-image
AI: upload paper form image, extract fields, create digital form
Upload a photo/scan of a paper form. AI extracts fields, maps to question types, creates a draft form.
multipart/form-data{
"image": "<binary>",
"form_name": "<string>"
}POST/form-builder/forms/getFormDetails
Get full form structure, rules, and settings
Detailed schema coming soon. Refer to the endpoint description above.
Form Builder
Manage form structure, add, update, delete, and reorder pages, sections, questions (28 types), and conditional rules.
POST/form-builder/structure/addPage
Add a page to the form
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/structure/addSection
Add a regular or repeatable section
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/structure/addQuestion
Add a question to a section (28 types supported)
Detailed schema coming soon. Refer to the endpoint description above.
PUT/form-builder/structure/update
Update question properties, validation, or config
Detailed schema coming soon. Refer to the endpoint description above.
DELETE/form-builder/structure/delete
Delete a page, section, or question
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/structure/reorder
Reorder pages, sections, or questions
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/rules/create
Create IF/THEN/ELSE conditional rule
Detailed schema coming soon. Refer to the endpoint description above.
PUT/form-builder/rules/update
Update rule conditions and actions
Detailed schema coming soon. Refer to the endpoint description above.
DELETE/form-builder/rules/delete
Delete a rule
Detailed schema coming soon. Refer to the endpoint description above.
Dispatch
Send forms to field agents via direct, broadcast (Uber-style), force-pull, or return for editing.
POST/forms/dispatchFormToUser
Dispatch form to users, direct, broadcast, or with field defaults
Dispatch a form to one or more users. Supports direct, broadcast (Uber-style first-wins), and pre-filled field defaults.
application/json{
"form_base_id": 0,
"user_ids": "<string[]>",
"dispatch_type": "direct",
"due_on": "2026-04-01T18:00:00Z",
"field_defaults": {},
"is_submittable": false,
"reassignable_users": "<string[]>",
"active_rule_groups": "[\"B\",\"C\"]"
}POST/forms/:id/forcePullForm
Force re-download of a form to user devices
Detailed schema coming soon. Refer to the endpoint description above.
POST/forms/:id/sendForEditing
Send a completed submission back for field editing
Send a completed submission back to the field agent for editing with an optional note.
application/json{
"user_forms_id": 0,
"note": "<string>",
"active_rule_groups": "[\"B\",\"C\"]"
}POST/forms/getDispatchSettings
Get dispatch config: geo-tag, pull, broadcast, acceptance
Detailed schema coming soon. Refer to the endpoint description above.
POST/forms/saveDispatchSettings
Save dispatch settings for a form
Detailed schema coming soon. Refer to the endpoint description above.
Scheduled Dispatch
Configure cron-based bulk dispatch with Excel user lists and field defaults. View run history and error logs.
POST/forms/scheduledDispatch/upsert
Create or update cron-based scheduled dispatch
Detailed schema coming soon. Refer to the endpoint description above.
GET/forms/scheduledDispatch/list
List scheduled dispatches for a form
Detailed schema coming soon. Refer to the endpoint description above.
POST/forms/scheduledDispatch/validateUpload
Validate scheduled dispatch Excel/ZIP payload
Detailed schema coming soon. Refer to the endpoint description above.
GET/forms/scheduledDispatch/downloadTemplate
Download Excel template for a form
Detailed schema coming soon. Refer to the endpoint description above.
DELETE/forms/scheduledDispatch/delete
Delete a scheduled dispatch
Detailed schema coming soon. Refer to the endpoint description above.
GET/forms/scheduledDispatch/runs
Get run history with status and error logs
Detailed schema coming soon. Refer to the endpoint description above.
Submissions & Exports
View, filter, export, and manage form submissions. Queue async detailed exports with presigned download URLs.
POST/dashboard/getFormSubmissions
List submissions with filters, search, and pagination
List submissions for a form with search, date filters, status filters, and pagination.
application/json{
"form_base_id": 0,
"page": 1,
"limit": 20,
"search": {}
}POST/dashboard/exportSubmissions
Export submissions as streaming XLSX or CSV
Detailed schema coming soon. Refer to the endpoint description above.
POST/dashboard/cancelSubmission
Cancel an active submission
Cancel an active submission. Sets status to Cancelled By Admin.
application/json{
"user_forms_id": 0
}POST/dashboard/reExecuteDataDestination
Re-trigger failed data destination connectors
Detailed schema coming soon. Refer to the endpoint description above.
POST/dashboard/getSubmissionOutputDetails
Get connector execution details for a submission
Detailed schema coming soon. Refer to the endpoint description above.
POST/dashboard/getVersionHistory
Get version history and audit trail
Detailed schema coming soon. Refer to the endpoint description above.
POST/export-requests/create
Queue async detailed export with S3 form data
Queue an async detailed export. Batch service processes it and stores result in S3.
application/json{
"form_base_id": 0,
"format": "xlsx",
"search": {}
}GET/export-requests/list
List export requests for current user
Detailed schema coming soon. Refer to the endpoint description above.
GET/export-requests/download
Get presigned download URL for completed export
Detailed schema coming soon. Refer to the endpoint description above.
Mobile Client
Mobile app endpoints, sync forms, submit data offline, pull self-service forms, accept or reject broadcast assignments.
POST/client/getUserForms
Sync assigned forms for the authenticated user
Detailed schema coming soon. Refer to the endpoint description above.
POST/client/getFormDetails
Download form structure, rules, and translations
Detailed schema coming soon. Refer to the endpoint description above.
GET/client/pullable
List self-service pullable forms
List forms available for self-service pull by the authenticated mobile user.
POST/client/pull
Pull a form instance (self-initiated)
Pull a form instance for the current user. Respects max_active_instances limit.
application/json{
"form_base_id": 0
}POST/client/submit
Submit form data (offline sync)
Submit form data from mobile device. Supports offline sync — may include file attachments.
application/json{
"user_forms_id": 0,
"form_data": {},
"submit_details": {}
}GET/client/pendingAcceptance
List broadcast forms awaiting acceptance
Detailed schema coming soon. Refer to the endpoint description above.
POST/client/accept
Accept a broadcast form (first-wins)
Detailed schema coming soon. Refer to the endpoint description above.
POST/client/reject
Reject a broadcast form
Detailed schema coming soon. Refer to the endpoint description above.
Data Destinations
Configure automated output connectors: Email, FTP, AWS S3, OneDrive, Google Sheets, Salesforce, SharePoint, webhooks, and more.
POST/form-builder/connectors/create
Create connector: Email, FTP, S3, OneDrive, Sheets, Salesforce, etc.
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/connectors/getAll
List all connectors
Detailed schema coming soon. Refer to the endpoint description above.
PUT/form-builder/connectors/update
Update connector configuration
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/connectors/linkToForm
Link connector to a form with optional filter
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/connectors/unlinkFromForm
Unlink connector from a form
Detailed schema coming soon. Refer to the endpoint description above.
DELETE/form-builder/connectors/delete
Delete a connector
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/filters/create
Create destination filter (conditional routing)
Detailed schema coming soon. Refer to the endpoint description above.
PUT/form-builder/filters/update
Update destination filter rules
Detailed schema coming soon. Refer to the endpoint description above.
Users & Access
Create and manage users, send notifications, reset passwords. Access controlled by 8-component RBAC.
POST/user/getAllUsers
List all users with roles and status
Detailed schema coming soon. Refer to the endpoint description above.
POST/user/addUser
Create a new user
Detailed schema coming soon. Refer to the endpoint description above.
POST/user/disableUser
Disable a user account
Detailed schema coming soon. Refer to the endpoint description above.
POST/user/sendNotification
Send push notification to selected users
Detailed schema coming soon. Refer to the endpoint description above.
POST/user/resetPassword
Admin-initiated password reset
Detailed schema coming soon. Refer to the endpoint description above.
AI & Analytics
Natural language form building, conversational data analytics, submission anomaly detection, and baseline computation.
POST/ai-chat/chat
AI form builder, natural language to form structure and rules
AI-powered form building. Send natural language instructions to create, modify, or delete form elements and rules.
application/json{
"form_base_id": 0,
"message": "Add a date selector called \"Inspection Date\" to the first section",
"session_id": "<string>"
}POST/ai-chat/analytics-chat
Conversational analytics, natural language to queries
Conversational analytics. Ask questions about submission data in natural language — AI generates safe read-only SQL.
application/json{
"form_base_id": 0,
"message": "What is the average score by region this month?"
}POST/forms/review/:id
AI anomaly detection, flag statistical outliers in submission
Detailed schema coming soon. Refer to the endpoint description above.
POST/baselines/:id/compute
Recompute statistical baselines for a form
Detailed schema coming soon. Refer to the endpoint description above.
Scheduled Reports
Automated cron-based report generation and email delivery with XLSX/CSV/PDF output formats.
POST/dashboard/scheduledReports/create
Create cron-based automated report
Detailed schema coming soon. Refer to the endpoint description above.
GET/dashboard/scheduledReports/list
List scheduled reports for a form
Detailed schema coming soon. Refer to the endpoint description above.
PUT/dashboard/scheduledReports/update
Update report schedule, recipients, and filters
Detailed schema coming soon. Refer to the endpoint description above.
DELETE/dashboard/scheduledReports/delete
Delete a scheduled report
Detailed schema coming soon. Refer to the endpoint description above.
GET/dashboard/scheduledReports/runs
Get run history with delivery status
Detailed schema coming soon. Refer to the endpoint description above.
Approval Workflows
Multi-step approval chains, configure steps, approve, reject, or send back. Supports user, role, and dynamic field approvers.
POST/approval-workflows/get
Get approval workflow configuration for a form
Detailed schema coming soon. Refer to the endpoint description above.
POST/approval-workflows/save
Save workflow with ordered approval steps
Save a multi-step approval workflow for a form. Replaces existing steps.
application/json{
"form_base_id": 0,
"steps": []
}POST/approval-workflows/approve
Approve current step, advances chain or completes
Approve the current step. Advances to next step or completes the submission.
application/json{
"approval_id": 0,
"comments": "<string>"
}POST/approval-workflows/reject
Reject, sends submission back for editing
Detailed schema coming soon. Refer to the endpoint description above.
POST/approval-workflows/send-back
Send back to previous approval step
Detailed schema coming soon. Refer to the endpoint description above.
GET/approval-workflows/pending
List submissions pending approval for current user
Detailed schema coming soon. Refer to the endpoint description above.
Languages & Translations
Manage multi-language support for forms. List supported languages, create and update field-level translations.
GET/form-builder/supported-languages
List all supported languages
Detailed schema coming soon. Refer to the endpoint description above.
GET/form-builder/translations/list
List translations for a form
Detailed schema coming soon. Refer to the endpoint description above.
POST/form-builder/translations/upsert
Create or update translation for a language
Detailed schema coming soon. Refer to the endpoint description above.
DELETE/form-builder/translations/delete
Delete translation for a language
Detailed schema coming soon. Refer to the endpoint description above.
Branding
White-label configuration, app name, logo, favicon, brand colors, and support contact info per customer.
GET/branding
Get branding configuration
Detailed schema coming soon. Refer to the endpoint description above.
PUT/branding
Update branding (app name, colors, support info)
Detailed schema coming soon. Refer to the endpoint description above.
POST/branding/logo
Upload brand logo
Detailed schema coming soon. Refer to the endpoint description above.
POST/branding/favicon
Upload favicon
Detailed schema coming soon. Refer to the endpoint description above.
