canonical: https://jentic.com/apis/alphasoftware.com/alphasoftware # Alphasoftware TransForm API Jentic publishes the only available OpenAPI specification for TransForm API, keeping it validated and agent-ready. Alpha TransForm is a mobile form-builder and field-data-collection platform, and this API exposes 12 endpoints for managing forms, submissions, and users programmatically. Teams use it to push form definitions out to mobile devices, pull captured submissions back into back-office systems, and provision users who collect data in the field. Authentication is a single X-API-Key header tied to an Alpha TransForm account. ## For AI agents Manage Alpha TransForm forms, field submissions, and users via 12 X-API-Key endpoints. Lets agents push form templates to mobile collectors and ingest the resulting submissions back into other systems. ## Scope Does not handle low-code app building, database queries, or report rendering - use only for managing TransForm mobile forms, submissions, and users. ## Capabilities - List, create, update, and delete mobile form templates via /forms - Retrieve submitted form responses and their captured field data through /submissions - Update individual submissions to correct or annotate field-collected data - Provision and manage TransForm user accounts that collect data in the field - Pull a single submission by ID for downstream processing or storage - Sync newly captured submissions into a CRM, warehouse, or document store ## Use cases ### Field Inspection Data Collection Operations teams build mobile inspection forms in Alpha TransForm and push them to field crews via the /forms endpoints. As crews submit inspections, the team pulls them back through /submissions and routes the structured data into work-order systems, asset registers, or compliance archives. The API removes manual export-import steps between mobile capture and back-office systems. Example prompt: Call GET /forms to find the form id for the daily safety inspection, then GET /submissions filtered by that form id and post each result to the work-order system. ### Submission-to-CRM Sync Sales and service teams using TransForm for on-site lead capture or service tickets pull each new /submissions entry into their CRM as soon as it arrives. The API exposes the full field payload of every submission, so the integration can map field answers onto CRM fields without screen scraping or CSV exports. Example prompt: Poll GET /submissions every 5 minutes, and for each new submission call GET `/submissions/{submissionId}` and create a matching record in the CRM using the field data. ### User Provisioning for Field Crews Larger TransForm deployments rotate field workers in and out of the platform regularly. The /users endpoints let an admin script provision new collectors with the correct profile and revoke access when crews leave, replacing manual user-management in the TransForm console. Example prompt: Create a TransForm user via POST /users with email and role, then GET /users to confirm the user appears in the active list. ### AI Agent Form Workflows via Jentic An AI agent built on Jentic can take a request like 'pull today's inspection submissions and email any failures to the supervisor' and resolve it to TransForm's submission endpoints plus an email API in a single workflow. The X-API-Key never leaves your Jentic One instance. Example prompt: Search Jentic for 'list TransForm submissions', load the GET /submissions schema, execute it filtered to today, and pass any flagged submissions to a downstream email tool. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/forms` | List form templates in the account | | POST | `/forms` | Create a new form template | | GET | `/forms/{formId}` | Retrieve a single form by id | | PATCH | `/forms/{formId}` | Update an existing form | | GET | `/submissions` | List captured form submissions | | GET | `/submissions/{submissionId}` | Get the full field payload for a submission | | PATCH | `/submissions/{submissionId}` | Update fields on an existing submission | | POST | `/users` | Provision a new TransForm user | ## Key resources - **Forms** — Manage form templates that mobile collectors fill out - **Submissions** — Retrieve and update field-captured submission payloads - **Users** — Provision and manage data-collector user accounts ## Why Jentic - **Setup:** Wiring the TransForm API by hand means attaching its API key to transform.alphasoftware.com and encoding the form, submission, and user calls yourself. Through Jentic you install once, import the TransForm API from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** The TransForm API puts the form and submission ids in the URL path (`/forms/{formId}`, `/submissions/{submissionId}`), so a rule can pin your agent to one form or submission. You choose the operations it may call, so patching a form or creating users is not included unless you add them. - **Credential handling:** Your TransForm API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list mobile forms' or 'read a form submission', and Jentic returns the matching TransForm operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Jotform API** — Web-first online form builder rather than mobile field capture - **Typeform API** — Conversational online forms optimised for marketing and survey response - **SurveyMonkey API** — Survey-focused form platform with response analytics ## FAQ ### Why is there no official OpenAPI spec for TransForm API? Alpha Software does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call TransForm API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the TransForm API use? TransForm uses an X-API-Key header on every request. Through Jentic, the key is stored encrypted in your Jentic One instance and injected at call time, so the raw key never appears in agent prompts or logs. ### Can I retrieve every submission for a specific form with the TransForm API? Yes. Call GET /submissions and filter by the form id you want, then call GET `/submissions/{submissionId}` for each row to expand the full field payload. ### What are the rate limits for the TransForm API? Specific limits are not published in the spec. Treat the API as account-throttled and add retry-with-backoff for 429 responses. For high-frequency polling of /submissions, use webhooks if your TransForm tier supports them and fall back to a 1-5 minute poll otherwise. ### How do I sync TransForm submissions into a CRM through Jentic? Search Jentic with the query 'list TransForm submissions', load the GET /submissions schema, execute it on a schedule, and pipe each new submission through your CRM's create-record operation in the same Jentic workflow. ### Can I delete or update a submitted form response with the TransForm API? Yes. Use PATCH `/submissions/{submissionId}` to update field values on an existing submission. There is no delete endpoint for submissions in the current spec, only for form templates via DELETE `/forms/{formId}.` ### Can I limit what my agent is allowed to do with the TransForm API? Yes. Jentic One runs self-hosted, so your own rules decide which TransForm operations the agent may call and which credentials it may use. Because form and submission ids sit in the URL path (`/forms/{formId}`, `/submissions/{submissionId}`), you can pin the agent to a single form or submission, and you pick the operations it is allowed to run, so writes like PATCH `/forms/{formId}` or POST /users stay off limits unless you add them. Everything else in the account remains untouched.