Intely

Intely Forms API

The Forms API helps you retrieve form related data including workspaces, forms, form fields, and submissions. The Forms API also contains routes to integrate with Zapier and subscribe to the submission webhook.

GitHub OpenAPI

Operations 11

GET /forms/api-key/validate Validate API key #
GET /forms/api/form/all Get forms #
GET /forms/api/form/fields/{formId} Get form fields #
GET /forms/api/form/submission/{formId} Get form submissions #
GET /forms/api/form/{formId} Get form #
GET /forms/api/workspace/all Get workspaces #
POST /forms/zapier/add Add Zapier webhook #
GET /forms/zapier/form/fields/{formId} Get Zapier form fields #
GET /forms/zapier/sample/submission Get Zapier form submissions #
POST /forms/zapier/submission/add Add Zapier form submission #
POST /forms/zapier/update/status Enable Zapier webhook #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/openapi/intely-forms-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/json-schema/intely-app-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/json-schema/intely-data-processor-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/json-schema/intely-rosetta-mapping-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/json-schema/intely-rosetta-comparison-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/json-schema/intely-app-instance-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/json-schema/intely-data-processor-job-execution-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/intely:intely-forms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

intely-forms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Intely Forms API
  version: 1.2.1
  termsOfService: https://www.intely.io/terms-and-conditions/
  contact:
    name: API Support
    url: https://support.intely.io/
    email: support@intely.io
  description: 'The Intely API provides a way to programmatically access and build on the Intely Platform. Intely

    provides infrastructure to connect data and automate interoperability workflows for vendors,

    applications and provider organizations.


    Intely has provided a variety of API endpoints to call to authenticate and connect to applications,

    execute pre-built integrations and data conversions, and use our form building modules. Many

    features need to be pre-configured in our platform, you can then select the APIs for your use case

    and implement quite easily.


    All URLs referenced in the API documentation have the following base: https://api.intely.io/v1


    The API is served over HTTPS. To ensure data privacy and security, unencrypted HTTP is not supported.'
servers:
- url: https://api.intely.io/v1
- url: https://api.stg.intely.io/v1
tags:
- name: Forms
  description: The Forms API helps you retrieve form related data including workspaces, forms, form fields, and submissions. The Forms API also contains routes to integrate with Zapier and subscribe to the submission webhook.
paths:
  /forms/api-key/validate:
    get:
      tags:
      - Forms
      summary: Validate API key
      description: Validates an API key and returns the user details related to the key.
      parameters:
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      responses:
        '200':
          description: Successfully validated the API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: object
                    properties:
                      firstName:
                        type: string
                      lastName:
                        type: string
                      email:
                        type: string
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid API key
        '403':
          description: Invalid permission
        '422':
          description: The API key is missing
        '500':
          description: Internal server error
      operationId: getFormsApiKeyValidate
      x-operation-id-source: derived
  /forms/api/form/all:
    get:
      tags:
      - Forms
      summary: Get forms
      description: Gets all of the forms for a user in the given workspace.
      parameters:
      - in: header
        name: workspaceid
        schema:
          type: string
        required: true
        description: The ID of the workspace the forms belongs to
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      - in: query
        name: skip
        schema:
          type: integer
          minimum: 0
        required: true
        description: The number of entries to skip
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
        required: true
        description: The number of entries to return
      - in: query
        name: sort
        schema:
          type: string
          enum:
          - createdAt
          - updatedAt
          - title
        required: true
        description: What property to sort the entries by
      responses:
        '200':
          description: Successfully returned a list of forms
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: object
                    properties:
                      totalCount:
                        type: integer
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Form'
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: getFormsApiFormAll
      x-operation-id-source: derived
  /forms/api/form/fields/{formId}:
    get:
      tags:
      - Forms
      summary: Get form fields
      description: Gets the fields of a specific form.
      parameters:
      - in: path
        name: formId
        schema:
          type: string
        required: true
        description: The ID of the form
      - in: header
        name: workspaceid
        schema:
          type: string
        required: true
        description: The ID of the workspace the form belongs to
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      responses:
        '200':
          description: Successfully got the fields of the form
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: object
                    properties:
                      fields:
                        type: array
                        items:
                          $ref: '#/components/schemas/FormField'
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: getFormsApiFormFieldsByFormId
      x-operation-id-source: derived
  /forms/api/form/submission/{formId}:
    get:
      tags:
      - Forms
      summary: Get form submissions
      description: Gets the submissions for an individual form.
      parameters:
      - in: path
        name: formId
        schema:
          type: string
        required: true
        description: The ID of the form
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      - in: query
        name: skip
        schema:
          type: integer
          minimum: 0
        required: true
        description: The number of entries to skip
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
        required: true
        description: The number of entries to return
      - in: query
        name: sort
        schema:
          type: string
          enum:
          - createdAt
          - updatedAt
          - title
        required: true
        description: What property to sort the entries by
      responses:
        '200':
          description: Successfully got the list of submissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: object
                    properties:
                      totalCount:
                        type: integer
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/FormSubmission'
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: getFormsApiFormSubmissionByFormId
      x-operation-id-source: derived
  /forms/api/form/{formId}:
    get:
      tags:
      - Forms
      summary: Get form
      description: Gets the details of an individual form.
      parameters:
      - in: path
        name: formId
        schema:
          type: string
        required: true
        description: The ID of the form
      - in: header
        name: workspaceid
        schema:
          type: string
        required: true
        description: The ID of the workspace the form belongs to
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      responses:
        '200':
          description: Successfully return the form details
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    $ref: '#/components/schemas/Form'
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: getFormsApiFormByFormId
      x-operation-id-source: derived
  /forms/api/workspace/all:
    get:
      tags:
      - Forms
      summary: Get workspaces
      description: Gets all of the workspaces for the user.
      parameters:
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      responses:
        '200':
          description: Succesfully returned the workspaces the user has access to
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: array
                    items:
                      type: object
                      properties:
                        _id:
                          type: string
                        workspaceStatus:
                          type: string
                        workspaceName:
                          type: string
                        workspaceType:
                          type: string
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: The API key is missing
        '500':
          description: Internal server error
      operationId: getFormsApiWorkspaceAll
      x-operation-id-source: derived
  /forms/zapier/add:
    post:
      tags:
      - Forms
      summary: Add Zapier webhook
      description: Adds a Zapier webhook to a form.
      parameters:
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      requestBody:
        description: The Zapier webhook information.
        content:
          application/json:
            schema:
              type: object
              properties:
                webhookUrl:
                  type: string
                formId:
                  type: string
                status:
                  type: string
                  example: Enabled
              required:
              - webhookUrl
              - formId
      responses:
        '201':
          description: Successfully added a Zapier webhook
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 201
                  payload:
                    type: object
                    properties:
                      _id:
                        type: string
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: postFormsZapierAdd
      x-operation-id-source: derived
  /forms/zapier/form/fields/{formId}:
    get:
      tags:
      - Forms
      summary: Get Zapier form fields
      description: Gets the form fields in the Zapier format for an individual form.
      parameters:
      - in: path
        name: formId
        schema:
          type: string
        required: true
        description: The ID of the form
      - in: header
        name: workspaceid
        schema:
          type: string
        required: true
        description: The ID of the workspace the form belongs to
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      responses:
        '200':
          description: Successfully got the form fields in the Zapier format
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: object
                    properties:
                      fields:
                        type: array
                        items:
                          $ref: '#/components/schemas/ZapierFormField'
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: getFormsZapierFormFieldsByFormId
      x-operation-id-source: derived
  /forms/zapier/sample/submission:
    get:
      tags:
      - Forms
      summary: Get Zapier form submissions
      description: Gets a form submission in the Zapier format.
      parameters:
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      - in: query
        name: formId
        schema:
          type: string
        required: true
        description: The ID of the form
      responses:
        '200':
          description: Successfully got a form submission in the Zapier format
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: object
                    properties:
                      formId:
                        type: string
                      ip:
                        type: string
                        format: ipv4
                      formFields:
                        type: object
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: getFormsZapierSampleSubmission
      x-operation-id-source: derived
  /forms/zapier/submission/add:
    post:
      tags:
      - Forms
      summary: Add Zapier form submission
      description: Add a form submission using a Zapier action.
      parameters:
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      requestBody:
        description: The form submission data.
        content:
          application/json:
            schema:
              type: object
              properties:
                formId:
                  type: string
                createdBy:
                  type: string
                rating:
                  type: number
                  format: float
                data:
                  type: array
                  items:
                    type: object
                reviewStatus:
                  type: boolean
                reviewBy:
                  type: string
                reviewDate:
                  type: string
                  format: date
                others:
                  type: object
              required:
              - formId
              - data
      responses:
        '201':
          description: Successfully created a form submission
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 201
                  payload:
                    type: object
                    properties:
                      _id:
                        type: string
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: postFormsZapierSubmissionAdd
      x-operation-id-source: derived
  /forms/zapier/update/status:
    post:
      tags:
      - Forms
      summary: Enable Zapier webhook
      description: Enable or disable a Zapier webhook.
      parameters:
      - in: query
        name: api_key
        schema:
          type: string
        required: true
        description: The API key
      requestBody:
        description: The Zapier webhook id and the status.
        content:
          application/json:
            schema:
              type: object
              properties:
                _id:
                  type: string
                status:
                  type: string
      responses:
        '200':
          description: Successfully update the Zapier webhook status
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  payload:
                    type: string
                    example: Updated Successfully
                  error:
                    type:
                    - string
                    - 'null'
                    example: null
        '401':
          description: Invalid or expired key
        '403':
          description: Invalid permission
        '422':
          description: Missing required input
        '500':
          description: Internal server error
      operationId: postFormsZapierUpdateStatus
      x-operation-id-source: derived
components:
  schemas:
    Form:
      type: object
      properties:
        _id:
          type: string
        title:
          type: string
        isFavourite:
          type: boolean
        createdAt:
          type: string
          format: date-time
        form_status:
          type: string
        numOfSubms:
          type: integer
        ratingAvg:
          type:
          - number
          - 'null'
          format: float
          example: null
    ZapierFormField:
      type: object
      properties:
        _id:
          type: string
        uuid:
          type: string
        text:
          type: string
        label:
          type: string
        options:
          type: array
          items:
            type: string
        isHippa:
          type: boolean
        isRequired:
          type: boolean
        returnType:
          type: string
        returnKey:
          type: string
        sampleReturnStructure:
          type: object
        returnSample:
          type: string
    FormField:
      type: object
      properties:
        _id:
          type: string
        uuid:
          type: string
        text:
          type: string
        label:
          type: string
        isHippa:
          type: boolean
        isRequired:
          type: boolean
        returnType:
          type: string
        returnKey:
          type: string
        sampleReturnStructure:
          type: object
    FormSubmission:
      type: object
      properties:
        ip:
          type: string
          format: ipv4
        rating:
          type: number
          format: float
        data:
          type: array
          items:
            $ref: '#/components/schemas/FormSubmissionElement'
        createdAt:
          type: string
          format: date-time
    FormSubmissionElement:
      type: object
      properties:
        elementID:
          type: string
        label:
          type: string
        isHippa:
          type: boolean
        textValue:
          type: string
        other:
          type: object
  securitySchemes:
    personal_token:
      type: http
      scheme: basic
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Privacy Policy
  url: https://www.intely.io/privacy-policy/
x-provenance:
  method: searched
  source: https://documentation.intely.io/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://documentation.intely.io/reference/delete_app-appid-instance-instanceid-webhook-webhookid.md
  - https://documentation.intely.io/reference/delete_app-appid-instance-instanceid.md
  - https://documentation.intely.io/reference/delete_storage-directory.md
  - https://documentation.intely.io/reference/delete_storage-file-delete.md
  - https://documentation.intely.io/reference/get_app-appid-instance-instanceid-webhook-webhookid.md
  - https://documentation.intely.io/reference/get_app-appid-instance-instanceid-webhooks.md
  - https://documentation.intely.io/reference/get_app-appid-instance-instanceid.md
  - https://documentation.intely.io/reference/get_app-appid-instances.md
  - https://documentation.intely.io/reference/get_app-appid.md
  - https://documentation.intely.io/reference/get_app-instances.md
  - https://documentation.intely.io/reference/get_apps.md
  - https://documentation.intely.io/reference/get_currentuser-validate.md
  - https://documentation.intely.io/reference/get_data-processor-job-jobid.md
  - https://documentation.intely.io/reference/get_data-processor-jobs.md
  - https://documentation.intely.io/reference/get_forms-api-form-all.md
  - https://documentation.intely.io/reference/get_forms-api-form-fields-formid.md
  - https://documentation.intely.io/reference/get_forms-api-form-formid.md
  - https://documentation.intely.io/reference/get_forms-api-form-submission-formid.md
  - https://documentation.intely.io/reference/get_forms-api-key-validate.md
  - https://documentation.intely.io/reference/get_forms-api-workspace-all.md
  - https://documentation.intely.io/reference/get_forms-zapier-form-fields-formid.md
  - https://documentation.intely.io/reference/get_forms-zapier-sample-submission.md
  - https://documentation.intely.io/reference/get_integration-integrationid.md
  - https://documentation.intely.io/reference/get_integrations.md
  - https://documentation.intely.io/reference/get_jwks.md
  - https://documentation.intely.io/reference/get_rosetta-comparison-comparisonid.md
  - https://documentation.intely.io/reference/get_rosetta-comparisons.md
  - https://documentation.intely.io/reference/get_rosetta-mapping-mappingid.md
  - https://documentation.intely.io/reference/get_rosetta-mappings.md
  - https://documentation.intely.io/reference/get_storage-directory-files.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-field-fieldid.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-restore.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-webhook-webhookid.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid.md
  - https://documentation.intely.io/reference/patch_storage-file-move.md
  - https://documentation.intely.io/reference/patch_storage-file-rename.md
  - https://documentation.intely.io/reference/post_app-appid-instance-instanceid-request-resourceid-actionid.md
  - https://documentation.intely.io/reference/post_app-appid-instance-instanceid-webhook.md
  - https://documentation.intely.io/reference/post_app-appid-instance.md
  - https://documentation.intely.io/reference/post_data-processor-job-jobid-execute-sync.md
  - https://documentation.intely.io/reference/post_data-processor-job-jobid-execute.md
  - https://documentation.intely.io/reference/post_forms-zapier-add.md
  - https://documentation.intely.io/reference/post_forms-zapier-submission-add.md
  - https://documentation.intely.io/reference/post_forms-zapier-update-status.md
  - https://documentation.intely.io/reference/post_integration-integrationid-execute-sync.md
  - https://documentation.intely.io/reference/post_integration-integrationid-execute.md
  - https://documentation.intely.io/reference/post_noauth-user-login-mcptoken.md
  - https://documentation.intely.io/reference/post_noauth-user-login-token.md
  - https://documentation.intely.io/reference/post_rosetta-comparison-comparisonid-execute-sync.md
  - https://documentation.intely.io/reference/post_rosetta-comparison-comparisonid-execute.md
  - https://documentation.intely.io/reference/post_rosetta-mapping-mappingid-execute-sync.md
  - https://documentation.intely.io/reference/post_rosetta-mapping-mappingid-execute.md
  - https://documentation.intely.io/reference/post_script-scriptid-execute-sync.md
  - https://documentation.intely.io/reference/post_script-scriptid-execute.md
  - https://documentation.intely.io/reference/post_storage-directory.md
  - https://documentation.intely.io/reference/post_storage-file-copy.md
  - https://documentation.intely.io/reference/post_storage-file-download.md
  - https://documentation.intely.io/reference/post_storage-file-upload-binary.md
  - https://documentation.intely.io/reference/post_storage-file-upload-multipart-start.md
  - https://documentation.intely.io/reference/post_storage-file-upload-multipart-uploadid-complete.md
  - https://documentation.intely.io/reference/post_storage-file-upload-multipart-uploadid-part.md
  - https://documentation.intely.io/reference/post_storage-file-upload-url.md
  - https://documentation.intely.io/reference/post_webhook-webhookid-app-appid-instance-instanceid.md
  merge:
    pages: 63
    deduped: 121
    conflicts_kept_first: 0