SoftSync AI Forms API

openapi: 3.2.0
info:
  title: Softsync Forms API
  description: '## Introduction


    The Softsync Platform API


    This API lets you read and write your Softsync data from your own applications. Authenticate with a personal API key created in **Settings → API Keys**, sent as the `x-api-key` header.


    **New here?** Read **Concepts** first, then **Authentication**, then **Quickstart: full cycle** — it walks the whole thing end to end. **Objects**, **Records**, **Groups & Views** and **Notes** cover each area in depth, and **Code Generation** shows how to turn this document into a typed client.


    To try a request from this page, paste your API key into the **Authentication** panel on the right.


    ## Support


    If you need help with API access or integration details, contact contact@softsync.ai.'
  version: 0.1.0
  contact: {}
servers: []
security:
- x-api-key: []
tags:
- name: Forms
paths:
  /forms:
    get:
      operationId: listForms
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: cursor
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List forms visible in the workspace without provisioning an object
      tags:
      - Forms
      x-feature: forms
    post:
      operationId: createForm
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFormDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Create a form
      tags:
      - Forms
      x-feature: forms
  /forms/{id}:
    get:
      operationId: getForm
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Read a form
      tags:
      - Forms
      x-feature: forms
    put:
      operationId: updateForm
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFormDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Update a form without changing its destination
      tags:
      - Forms
      x-feature: forms
    delete:
      operationId: deleteForm
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - bearer: []
      summary: Delete a form
      tags:
      - Forms
      x-feature: forms
  /forms/{id}/regenerate:
    post:
      operationId: regenerateFormLink
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Invalidate old public form links
      tags:
      - Forms
      x-feature: forms
components:
  schemas:
    FormDestinationDto:
      type: object
      properties:
        path:
          type: string
        groupId:
          type: string
      required:
      - path
      - groupId
    FormFieldDto:
      type: object
      properties:
        key:
          type: string
        fieldId:
          type: string
        label:
          type: string
        required:
          type: boolean
        where:
          description: 'Link questions only: visitors pick from the linked records that match every condition.'
          type: array
          items:
            $ref: '#/components/schemas/FormPickFilterDto'
        fromLink:
          type: boolean
          description: 'Link questions only: no list is shown; the record comes from the form''s link (e.g. a portal button), so visitors never see the others.'
      required:
      - fieldId
    FormConfigurationDto:
      type: object
      properties:
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/FormDestinationDto'
        fieldOrder:
          type: array
          items:
            type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FormFieldDto'
        automatic:
          type: array
          items:
            $ref: '#/components/schemas/FormAutomaticDto'
        design:
          type: string
          enum:
          - minimal
          - card
          - split
          - compact
          - bold
        successMessage:
          type: string
        redirectUrl:
          type: string
        notifyUserIds:
          type: array
          items:
            type: string
      required:
      - fields
      - design
      - successMessage
    FormAutomaticDto:
      type: object
      properties:
        key:
          type: string
        label:
          type: string
        fieldId:
          type: string
        mode:
          type: string
          enum:
          - fixed
          - template
          - submitted_at
          - booked_at
        value:
          type: string
        parts:
          type: array
          items:
            $ref: '#/components/schemas/FormValuePartDto'
      required:
      - fieldId
      - mode
    CreateFormDto:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        configuration:
          $ref: '#/components/schemas/FormConfigurationDto'
        groupId:
          type: string
        tableId:
          type: string
      required:
      - title
      - description
      - enabled
      - configuration
      - groupId
      - tableId
    FormValuePartDto:
      type: object
      properties:
        type:
          type: string
          enum:
          - text
          - answer
          - date
          - time
          - datetime
        value:
          type: string
      required:
      - type
    FormPickFilterDto:
      type: object
      properties:
        fieldId:
          type: string
        equals:
          oneOf:
          - type: string
          - type: number
          - type: boolean
      required:
      - fieldId
      - equals
    UpdateFormDto:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        configuration:
          $ref: '#/components/schemas/FormConfigurationDto'
        groupId:
          type: string
          description: Move the form to another group, e.g. when its group was deleted. Admins only.
      required:
      - title
      - description
      - enabled
      - configuration
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key