Intely Connect API

openapi: 3.2.0
info:
  title: Intely Connect 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: Connect
  description: The Connect API helps you retrieve and programmatically execute pre-built data integration workflows. Before accessing Connect routes, please make sure you have pre-configured an integration in the Intely Platform.
paths:
  /integration/{integrationId}:
    get:
      tags:
      - Connect
      summary: Get integration
      description: Returns details of a specific integration.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: integrationId
        schema:
          type: string
        required: true
        description: The ID of the integration
      responses:
        '200':
          description: Successfully returned the integration details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integration'
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: getIntegrationByIntegrationId
      x-operation-id-source: derived
  /integration/{integrationId}/execute:
    post:
      tags:
      - Connect
      summary: Execute integration (asynchronous)
      description: Executes an integration asynchronously.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: integrationId
        schema:
          type: string
        required: true
        description: The ID of the integration
      - in: query
        name: emailToNotify
        schema:
          type: string
        required: false
        description: The email address to notify when the integration finishes.
      - in: query
        name: callbackUrl
        schema:
          type: string
        required: false
        description: The callback URL to send the response to once the integration finishes.
      requestBody:
        description: The integration configuration data
        content:
          application/json:
            schema:
              type: object
              properties:
                dryRun:
                  type: boolean
                  example: false
                  default: false
                  description: Set to true if the integration should not actually process data.
                outputLog:
                  type: boolean
                  example: false
                  default: false
                  description: Set to true if you want to return the entire log of the integration run.
                ignoreStatus:
                  type: boolean
                  example: false
                  default: false
                  description: Set to true if you want to run this integration regardless of it's status
                triggerData:
                  oneOf:
                  - type: object
                  - type: string
                  description: Data provided to the integration trigger. This will be exposed to subsequent steps for data retrieval. Required if providing triggerDataTypeId.
      responses:
        '200':
          description: Successfully scheduled an integration to run
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  taskId:
                    type: string
                  executionId:
                    type: string
                  startTime:
                    type: string
                  createdBy:
                    type: string
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postIntegrationByIntegrationIdExecute
      x-operation-id-source: derived
  /integration/{integrationId}/execute/sync:
    post:
      tags:
      - Connect
      summary: Execute integration (synchronous)
      description: Executes an integration synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the integration takes longer than 60 seconds to run.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: integrationId
        schema:
          type: string
        required: true
        description: The ID of the integration
      requestBody:
        description: The integration configuration data
        content:
          application/json:
            schema:
              type: object
              properties:
                dryRun:
                  type: boolean
                  example: false
                  default: false
                  description: Set to true if the integration should not actually process data.
                outputLog:
                  type: boolean
                  example: false
                  default: false
                  description: Set to true if you want to return the entire log of the integration run.
                ignoreStatus:
                  type: boolean
                  example: false
                  default: false
                  description: Set to true if you want to run this integration regardless of it's status
                triggerData:
                  oneOf:
                  - type: object
                  - type: string
                  description: Data provided to the integration trigger. This will be exposed to subsequent steps for data retrieval. Required if providing triggerDataTypeId.
      responses:
        '200':
          description: Successfully executed an integration
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  exitStatus:
                    type: integer
                  executionId:
                    type: string
                  additionalData:
                    type: object
                  log:
                    type: array
                    items:
                      type: object
                  outputs:
                    type: array
                    items:
                      type: object
                  errors:
                    type: array
                    items:
                      type: object
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postIntegrationByIntegrationIdExecuteSync
      x-operation-id-source: derived
  /integrations:
    get:
      tags:
      - Connect
      summary: Get integrations
      description: Returns a list of integrations the user has access to.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      responses:
        '200':
          description: Successfully returned the list of integrations
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Integration'
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: getIntegrations
      x-operation-id-source: derived
  /script/{scriptId}/execute:
    post:
      tags:
      - Connect
      summary: Execute Script (asynchronous)
      description: Executes a script asynchronously.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: scriptId
        schema:
          type: string
        required: true
        description: The ID of the script to run
      - in: query
        name: emailToNotify
        schema:
          type: string
        required: false
        description: The email address to notify when the script finishes.
      - in: query
        name: callbackUrl
        schema:
          type: string
        required: false
        description: The callback URL to send the response to once the script finishes.
      requestBody:
        description: The script configuration data
        content:
          application/json:
            schema:
              type: object
              properties:
                parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: Script parameter name
                      encodedValue:
                        type: string
                        description: JSON encoded values relative to the parameters expected format
                    required:
                    - name
                    - encodedValue
            example:
              parameters:
              - name: example-string-parameter-format
                encodedValue: string value
              - name: example-string-array-parameter-format
                encodedValue: '["string value"]'
              - name: example-number-parameter-format
                encodedValue: '3.14159'
              - name: example-number-array-parameter-format
                encodedValue: '[1,2.5,6]'
              - name: example-date-parameter-format
                encodedValue: '1999-05-19'
              - name: example-date-array-parameter-format
                encodedValue: '["2002-05-16","2005-05-19"]'
              - name: example-date-time-parameter-format
                encodedValue: '2015-12-18T21:56:41.957Z'
              - name: example-date-time-array-parameter-format
                encodedValue: '["2017-12-15T01:56:00.957Z","2019-12-20T21:10:00.900Z"]'
              - name: example-json-parameter-format
                encodedValue: '{"name":"John Doe","addressLines":["1234 Sample Street","Apt A01"]}'
              - name: example-json-array-parameter-format
                encodedValue: '[{"name":"John Doe","addressLines":["1234 Sample Street","Apt A01"]},{"name":"Jane Doe","addressLines":["5678 Sample Ave"]}]'
      responses:
        '200':
          description: Successfully scheduled a script to run
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  taskId:
                    type: string
                  executionId:
                    type: string
                  startTime:
                    type: string
                  createdBy:
                    type: string
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postScriptByScriptIdExecute
      x-operation-id-source: derived
  /script/{scriptId}/execute/sync:
    post:
      tags:
      - Connect
      summary: Execute Script (synchronous)
      description: Executes a script synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the script takes longer than 60 seconds to run.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: scriptId
        schema:
          type: string
        required: true
        description: The ID of the script to run
      requestBody:
        description: The script configuration data
        content:
          application/json:
            schema:
              type: object
              properties:
                parameters:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: Script parameter name
                      encodedValue:
                        type: string
                        description: JSON encoded values relative to the parameters expected format
                    required:
                    - name
                    - encodedValue
            example:
              parameters:
              - name: example-string-parameter-format
                encodedValue: string value
              - name: example-string-array-parameter-format
                encodedValue: '["string value"]'
              - name: example-number-parameter-format
                encodedValue: '3.14159'
              - name: example-number-array-parameter-format
                encodedValue: '[1,2.5,6]'
              - name: example-date-parameter-format
                encodedValue: '1999-05-19'
              - name: example-date-array-parameter-format
                encodedValue: '["2002-05-16","2005-05-19"]'
              - name: example-date-time-parameter-format
                encodedValue: '2015-12-18T21:56:41.957Z'
              - name: example-date-time-array-parameter-format
                encodedValue: '["2017-12-15T01:56:00.957Z","2019-12-20T21:10:00.900Z"]'
              - name: example-json-parameter-format
                encodedValue: '{"name":"John Doe","addressLines":["1234 Sample Street","Apt A01"]}'
              - name: example-json-array-parameter-format
                encodedValue: '[{"name":"John Doe","addressLines":["1234 Sample Street","Apt A01"]},{"name":"Jane Doe","addressLines":["5678 Sample Ave"]}]'
      responses:
        '200':
          description: Successfully executed a script
          content:
            application/json:
              schema:
                type: object
                properties:
                  scriptOutput:
                    type: object
                  logs:
                    type: array
                    items:
                      type: string
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postScriptByScriptIdExecuteSync
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
        error:
          type: string
        isError:
          type: boolean
    Integration:
      type: object
      properties:
        _id:
          type: string
        name:
          type: string
        description:
          type: string
        steps:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationStep'
        organizationId:
          type: string
        userId:
          type: string
        status:
          type: integer
          enum:
          - 1
          - 2
          - 3
        isTemplate:
          type: boolean
        deletedAt:
          type: string
          format: date-time
        runTime:
          type: string
          format: date-time
        isRunning:
          type: boolean
    IntegrationStep:
      type: object
      properties:
        stepType:
          type: string
        stepId:
          type: integer
        descripton:
          type: string
        prevSteps:
          type: array
          items:
            type: string
        nextSteps:
          type: array
          items:
            type: string
        continueIfFailed:
          type: boolean
        numberOfRetries:
          type: integer
        parameters:
          type: array
          items:
            type: string
        vendorId:
          type: string
        vendorInstanceId:
          type: string
        action:
          type: string
        resource:
          type: string
        triggerType:
          type: string
        startTime:
          type: string
          format: date-time
        freq:
          type: integer
          enum:
          - 0
          - 1
        interval:
          type: integer
        monthlyInterval:
          type: string
  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