vCita Forms API

The Forms API from vCita — 5 operation(s) for forms.

GitHub OpenAPI

Operations 6

GET /client_api/v1/portals/{business_uid}/contact/get_form Get Leave Details Form #
POST /client_api/v1/portals/{business_uid}/contact/submit Submits Leave Details Form #
GET /client_api/v1/portals/{business_uid}/share_documents_form/get_form Get Share Documents Form #
POST /client_api/v1/portals/{business_uid}/share_documents_form/submit Submits Share Documents Form #
GET /platform/v1/forms Get Forms List #
PUT /platform/v1/forms Updates a Form #

Specifications

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/vcita:vcita-forms-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

vcita-forms-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Assets Forms API
  description: Unified OpenAPI specification for assets domain
  version: '3.0'
  x-generated:
    sourceFiles:
    - files.json
    - legacy_documents.json
    pathNormalizations: []
    pathConflicts: []
    componentConflicts:
    - type: schema
      name: ErrorResponse
      resolution: Renamed to ErrorResponse_legacy_documents
      files:
      - merged
      - legacy_documents.json
    totalPaths: 11
    totalComponents: 9
servers:
- url: https://api.vcita.biz
  description: Unified API Gateway server
tags:
- name: Forms
paths:
  /client_api/v1/portals/{business_uid}/contact/get_form:
    get:
      tags:
      - Forms
      summary: Get Leave Details Form
      description: '## Overview

        Gets the leave details form of the business.


        ## Authentication

        **Available for Client Tokens only.**'
      parameters:
      - name: business_uid
        in: path
        description: business_uid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  description: Please fill out your details below so we can process your request.
                  sections:
                  - description: Please fill out your details below so we can process your request.
                    fields:
                    - - hidden: false
                        id: subject
                        label: Subject
                        required: true
                        type: subject
                    - - hidden: false
                        id: message
                        label: Message
                        required: true
                        type: multiline
                    title: ''
                    type: message_info
                  - description: 'translation missing: en.settings.forms.leave_details.section.client_details.description'
                    editable: true
                    fields:
                    - - default_value: ''
                        id: 6tg9ode4uj2accvx
                        keep_asking: false
                        label: email_label
                        object_type: contact
                        required: true
                        type: email
                    - - default_value: ''
                        id: qkq65wh8577vio6q
                        keep_asking: false
                        label: firstname_label
                        object_type: contact
                        required: true
                        type: firstname
                    title: Client Info
                    type: fields
                  - description: Enter a message you want your clients to read before they submit
                    fields:
                    - - default_value: ''
                        enabled: false
                        label: Business policy
                        type: policy
                    title: Business policy
                    type: policies
                  title: Leave details form
                  type: leave_details
                status: OK
      security:
      - Bearer: []
      operationId: getClientApiV1PortalsByBusinessUidContactGetForm
      x-operation-id-source: derived
  /client_api/v1/portals/{business_uid}/contact/submit:
    post:
      tags:
      - Forms
      summary: Submits Leave Details Form
      description: '## Overview

        Submits Leave Details Form to the business.


        ## Authentication

        **Available for Client Tokens only.**


        ## Required Fields

        Before submitting, call `GET /client_api/v1/portals/{business_uid}/contact/get_form` to discover required fields for the business''s form configuration.


        For the default `leave_details` form, `subject` and `message` are typically required fields. Any field marked with `required: true` in the form response must be provided with a non-empty value, or the API returns HTTP 422.


        ## Request Body Structure

        The `form_data.fields` object is a dynamic map where keys are field IDs and values are the field values. Field IDs can be obtained from the GET form response.'
      parameters:
      - name: business_uid
        in: path
        description: business_uid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - form_data
              properties:
                form_data:
                  type: object
                  required:
                  - fields
                  description: Form data containing field values. This is an object (NOT an array) with a 'fields' property.
                  properties:
                    fields:
                      type: object
                      description: Dynamic map of field IDs to values. Field IDs include fixed keys like 'subject' and 'message', plus any custom field IDs from the form configuration. Get valid field IDs from GET /client_api/v1/portals/{business_uid}/contact/get_form.
                      additionalProperties:
                        type: string
                      example:
                        subject: Contact inquiry
                        message: Hello, I would like more information
                source_data:
                  type: object
                  properties:
                    isWidget:
                      description: Whether the form was submitted from a widget. **Must be a boolean value (true/false), not a string.**
                      type: boolean
                    o:
                      description: The origin type in Base64
                      type: string
                    s:
                      description: The source url
                      type: string
                    topUrl:
                      description: The top url in Base64
                      type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  auto_reply_message: null
                  conversation_uid: ppnmz70yqxltzz6j
                  id: 22
                  uid: xlc8czadb3tyag1k
                status: OK
        '422':
          description: Validation Error - Empty or missing required fields. Use GET .../contact/get_form to discover required field IDs.
          content:
            application/json:
              example:
                errors:
                - code: invalid
                  field: subject
                  message: This field cannot be empty
                success: false
      security:
      - Bearer: []
      operationId: postClientApiV1PortalsByBusinessUidContactSubmit
      x-operation-id-source: derived
  /client_api/v1/portals/{business_uid}/share_documents_form/get_form:
    get:
      tags:
      - Forms
      summary: Get Share Documents Form
      description: '## Overview

        Gets the share documents form of the business.


        ## Authentication

        **Available for Client Tokens only.**'
      parameters:
      - name: business_uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Share Documents Form
          content:
            application/json:
              example:
                data:
                - description: Please fill out your details below so we can process your request.
                  sections:
                  - description: Please fill out your details below so we can process your request.
                    fields:
                    - - id: documents
                        label: Select your files
                        required: true
                        type: documents
                    - - id: title
                        label: Document Title
                        required: false
                        type: title
                    - - id: message
                        label: Message
                        required: false
                        type: multiline
                    title: ''
                    type: message_info
                  title: Share documents form
                  type: share_documents
                status: OK
      security:
      - Bearer: []
      operationId: getClientApiV1PortalsByBusinessUidShareDocumentsFormGetForm
      x-operation-id-source: derived
  /client_api/v1/portals/{business_uid}/share_documents_form/submit:
    post:
      tags:
      - Forms
      summary: Submits Share Documents Form
      description: '## Overview

        Submits Share Documents Form to the business.


        ## Authentication

        **Available for Client Tokens only.**


        ## Critical Requirement

        The `matter_uid` query parameter must reference a matter with an assigned staff member. Without this, the endpoint returns 500 due to a server-side bug.


        ## Request Format

        This endpoint requires `multipart/form-data` format with actual binary file uploads (not JSON). Documents must be uploaded as form fields with proper content types.


        ## Important: Field Naming Convention

        **Document fields MUST use explicit numeric indices** (e.g., `[0]`, `[1]`), NOT empty brackets `[]`.


        - Correct: `form_data[fields][documents][0]=@file.pdf`

        - Wrong: `form_data[fields][documents][]=@file.pdf` (causes 500 error)


        This is because the server expects a Hash structure, not an Array.


        ## Captcha

        When the business has the `captcha_intake_form` feature enabled, a valid `captcha_token` is required.


        ## Example cURL

        ```bash

        curl -X POST ''https://api.vcita.biz/client_api/v1/portals/{business_uid}/share_documents_form/submit?matter_uid={matter_uid}'' \

        -H ''Authorization: Bearer {token}'' \

        -F ''form_data[fields][title]=My Document'' \

        -F ''form_data[fields][message]=Please review'' \

        -F ''form_data[fields][documents][0]=@file.pdf;type=application/pdf''

        ```'
      parameters:
      - name: business_uid
        in: path
        required: true
        schema:
          type: string
      - name: matter_uid
        in: query
        required: true
        description: 'The matter/conversation UID to associate with the document upload. **Critical**: The matter must have an assigned staff member to avoid 500 errors.'
        schema:
          type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - form_data[fields][documents][0]
              properties:
                form_data[fields][title]:
                  type: string
                  description: Document title
                form_data[fields][message]:
                  type: string
                  description: Message accompanying the documents
                form_data[fields][documents][0]:
                  type: string
                  format: binary
                  description: 'File to upload. **Important**: Use explicit indices `[0]`, `[1]`, etc. - NOT empty brackets `[]`. For multiple files, use `form_data[fields][documents][0]`, `form_data[fields][documents][1]`, etc.'
                captcha_token:
                  type: string
                  description: reCAPTCHA token. Required when business has captcha_intake_form feature enabled.
      responses:
        '200':
          description: Success - Documents submitted successfully.
          content:
            application/json:
              example:
                data:
                  id: 142055507
                  uid: gpybls1zgpmono0o
                  conversation_uid: hf3gtvitw2ycg3ix
                  auto_reply_message: Thank you for your message.
                status: OK
        '422':
          description: 'Validation Error or Business Blocked.


            **Validation Error**: Missing required fields like documents.


            **Business Blocked**: When the business is flagged as spammer or user access is blocked, returns 422 with NO explicit error message - only `auto_reply_message` in the data object.'
          content:
            application/json:
              examples:
                validation_error:
                  value:
                    errors:
                    - code: invalid
                      field: documents
                      message: Documents are required
                    success: false
        '500':
          description: Internal Server Error. Occurs when the matter does not have an assigned staff member or when an empty JSON body is sent instead of multipart/form-data.
          content:
            application/json:
              example:
                error: undefined method `can_receive_sms?' for nil:NilClass
                status: Error
      security:
      - Bearer: []
      operationId: postClientApiV1PortalsByBusinessUidShareDocumentsFormSubmit
      x-operation-id-source: derived
  /platform/v1/forms:
    get:
      tags:
      - Forms
      summary: Get Forms List
      description: '## Overview

        Get forms list.


        ## Authentication

        **Available for Staff, App, and Directory tokens.**'
      parameters:
      - name: page
        in: query
        description: 'Page number of results. Default: 1'
        required: false
        schema:
          type: integer
      - name: per_page
        in: query
        description: 'How many items to return per page. Default: 25. Max: 100'
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  forms: []
                status: OK
      security:
      - Bearer: []
      operationId: getPlatformV1Forms
      x-operation-id-source: derived
    put:
      tags:
      - Forms
      summary: Updates a Form
      description: '## Overview

        Update a Form.


        ## Authentication

        **Available for Staff, App, and Directory tokens.**'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sections:
                  description: A list sections in the form
                  type: array
                  items:
                    type: object
                    properties:
                      fields:
                        description: A list fields in the form
                        type: array
                        items:
                          type: object
                          properties:
                            default_value:
                              description: The default value the field should have
                              type: string
                            id:
                              description: Field Id
                              type: string
                            keep_asking:
                              description: Should a value be requested until one was provided?
                              type: boolean
                            required:
                              description: Is this field required?
                              type: boolean
                            type:
                              description: Field Type
                              type: string
                type:
                  description: The type of the form
                  type: string
      responses:
        '200':
          description: Form Updated
          content:
            application/json:
              example:
                data:
                  sections:
                  - editable: true
                    fields:
                    - default_value: ''
                      id: qh0ki5qtre0ayi0q
                      keep_asking: false
                      required: false
                      type: singleline
                  type: client_card
                status: OK
      security:
      - Bearer: []
      operationId: putPlatformV1Forms
      x-operation-id-source: derived
components:
  securitySchemes:
    Files:
      type: http
      scheme: bearer
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
x-provenance:
  method: searched
  source: https://developers.intandem.tech:443/reference
  harvested: '2026-11-15'
  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://developers.intandem.tech/reference/filerelationscontroller_create.md
  - https://developers.intandem.tech/reference/filerelationscontroller_deleterelation.md
  - https://developers.intandem.tech/reference/filerelationscontroller_findbyentity.md
  - https://developers.intandem.tech/reference/filescontroller_delete.md
  - https://developers.intandem.tech/reference/filescontroller_findall.md
  - https://developers.intandem.tech/reference/filescontroller_findone.md
  - https://developers.intandem.tech/reference/filescontroller_upload.md
  - https://developers.intandem.tech/reference/get_client-api-v1-portals-business-uid-contact-get-form-1.md
  - https://developers.intandem.tech/reference/get_client-api-v1-portals-business-uid-share-documents-form-get-form-1.md
  - https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-documents-1.md
  - https://developers.intandem.tech/reference/get_platform-v1-forms.md
  - https://developers.intandem.tech/reference/get_v2-search-search-docuforms-1.md
  - https://developers.intandem.tech/reference/post_client-api-v1-portals-business-uid-contact-submit-1.md
  - https://developers.intandem.tech/reference/post_client-api-v1-portals-business-uid-share-documents-form-submit-1.md
  - https://developers.intandem.tech/reference/put_platform-v1-forms.md
  - https://developers.intandem.tech:443/reference/filerelationscontroller_create.md
  - https://developers.intandem.tech:443/reference/filerelationscontroller_deleterelation.md
  - https://developers.intandem.tech:443/reference/filerelationscontroller_findbyentity.md
  - https://developers.intandem.tech:443/reference/filescontroller_delete.md
  - https://developers.intandem.tech:443/reference/filescontroller_findall.md
  - https://developers.intandem.tech:443/reference/filescontroller_findone.md
  - https://developers.intandem.tech:443/reference/filescontroller_upload.md
  - https://developers.intandem.tech:443/reference/get_client-api-v1-portals-business-uid-contact-get-form-1.md
  - https://developers.intandem.tech:443/reference/get_client-api-v1-portals-business-uid-share-documents-form-get-form-1.md
  - https://developers.intandem.tech:443/reference/get_platform-v1-clients-client-id-documents-1.md
  - https://developers.intandem.tech:443/reference/get_platform-v1-forms.md
  - https://developers.intandem.tech:443/reference/get_v2-search-search-docuforms-1.md
  - https://developers.intandem.tech:443/reference/post_client-api-v1-portals-business-uid-contact-submit-1.md
  - https://developers.intandem.tech:443/reference/post_client-api-v1-portals-business-uid-share-documents-form-submit-1.md
  - https://developers.intandem.tech:443/reference/put_platform-v1-forms.md
  merge:
    pages: 30
    deduped: 74
    conflicts_kept_first: 0