Clipform Integrations API

The connect lane an installed app uses on a user's behalf - identify the workspace, list its forms, and subscribe to form completions. Used by the Clipform apps for Zapier, Make and n8n.

GitHub OpenAPI

Operations 4

GET /connect/me Get the connected workspace #
GET /connect/forms List published forms #
POST /connect/hooks Subscribe to form completions #
DELETE /connect/hooks/{hookId} Unsubscribe from form completions #

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/clipform-io:clipform-io-integrations-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. See our Privacy Policy and Terms.

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

OpenAPI Specification

clipform-io-integrations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Clipform Io Integrations API
  version: 1.0.0
  contact:
    name: Clipform
    url: https://clipform.io
    email: support@clipform.io
  termsOfService: https://clipform.io/terms
  description: 'Operations tagged Integrations across 2 of this provider''s published API definitions: api.clipform.io_openapi.json, clipform-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.clipform.io/v1
  description: Production
  x-internal: false
tags:
- name: Integrations
  x-displayName: Integrations
  description: The connect lane an installed app uses on a user's behalf - identify the workspace, list its forms, and subscribe to form completions. Used by the Clipform apps for Zapier, Make and n8n.
paths:
  /connect/me:
    get:
      operationId: getConnectedWorkspace
      tags:
      - Integrations
      summary: Get the connected workspace
      description: Returns the workspace the calling OAuth token or API key is bound to, for use as a connection test.
      security:
      - oauth2: []
      - bearerAuth: []
      responses:
        '200':
          description: The workspace this credential is connected to.
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace_id:
                    type: string
                    format: uuid
                    example: 550e8400-e29b-41d4-a716-446655440000
                    maxLength: 36
                  workspace_name:
                    type: string
                    example: Acme Marketing
                    maxLength: 2000
        '401':
          description: Missing, invalid, or expired credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.clipform.io/v1
      description: Production
      x-internal: false
  /connect/forms:
    get:
      operationId: listConnectForms
      tags:
      - Integrations
      summary: List published forms
      description: Lists the workspace's published forms as id, title and share id, for populating a form picker in an integration.
      security:
      - oauth2:
        - forms:read
      - bearerAuth: []
      responses:
        '200':
          description: Published forms in the connected workspace, most recently updated first.
          content:
            application/json:
              schema:
                type: array
                maxItems: 1000
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      example: f47ac10b-58cc-4372-a567-0e02b2c3d479
                      maxLength: 36
                    title:
                      type: string
                      example: Customer Feedback
                      maxLength: 2000
                    share_id:
                      type: string
                      example: abc12345
                      maxLength: 2000
        '403':
          description: The credential is missing the forms:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.clipform.io/v1
      description: Production
      x-internal: false
  /connect/hooks:
    post:
      operationId: subscribeWebhook
      tags:
      - Integrations
      summary: Subscribe to form completions
      description: Registers a target URL that receives the form.completed payload for every form in the connected workspace.
      security:
      - oauth2:
        - webhooks:manage
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - targetUrl
              properties:
                targetUrl:
                  type: string
                  format: uri
                  description: HTTPS endpoint Clipform POSTs each completion to. Must be publicly resolvable.
                  example: https://hook.eu1.make.com/abc123
                  maxLength: 2000
      responses:
        '201':
          description: Subscription created, or an existing subscription for the same URL reactivated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Subscription id - pass it to the unsubscribe operation.
                    example: 6f4b2c1e-0d3a-4a2b-9c8d-1e2f3a4b5c6d
                    maxLength: 36
        '400':
          description: targetUrl is missing or is not a safe public URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The credential is missing the webhooks:manage scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.clipform.io/v1
      description: Production
      x-internal: false
  /connect/hooks/{hookId}:
    delete:
      operationId: unsubscribeWebhook
      tags:
      - Integrations
      summary: Unsubscribe from form completions
      description: Deactivates a webhook subscription so Clipform stops POSTing completions to its target URL.
      security:
      - oauth2:
        - webhooks:manage
      - bearerAuth: []
      parameters:
      - name: hookId
        in: path
        required: true
        description: Subscription id returned when the webhook was registered.
        schema:
          type: string
          format: uuid
          example: 6f4b2c1e-0d3a-4a2b-9c8d-1e2f3a4b5c6d
          maxLength: 36
      responses:
        '200':
          description: Subscription deactivated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          description: The subscription id is not a valid identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The subscription belongs to a different workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No subscription with that id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.clipform.io/v1
      description: Production
      x-internal: false
components:
  schemas:
    Error:
      type: object
      description: Standard error envelope returned by every failed request.
      required:
      - code
      - error
      properties:
        code:
          type: string
          description: Machine-readable error code. Keep in lockstep with the ErrorCode union in apps/api/src/lib/errors.ts (source of truth).
          enum:
          - VALIDATION_ERROR
          - UNKNOWN_SESSION
          - RATE_LIMITED
          - UNAUTHORIZED
          - FORBIDDEN
          - NOT_FOUND
          - INTERNAL_ERROR
          - RENDER_FAILED
          - PAYMENT_ERROR
          - BOOKING_ERROR
          - PLAN_LIMIT
          - RESPONSE_LIMIT
          - CONFLICT
        error:
          type: string
          description: Human-readable error message.
          maxLength: 2000
        details:
          description: 'Optional structured detail; present on some validation errors. The fallback 401 ("Authentication required...") carries `details.reason` for a rejected Bearer session token: `no_token`, `token_rejected`, `auth_unavailable`, `not_a_member`, `no_workspace`, `membership_lookup_failed`, or `not_evaluated`, plus `auth_code` and `auth_status` when the auth provider returned them.'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key (cf_*) passed as Bearer token
    oauth2:
      type: oauth2
      description: Authorization-code OAuth for installed apps acting on a user's workspace. Access tokens (cf_at_*) are passed as Bearer tokens and authorize the Integrations operations. They are opaque, single-audience, server-side records. Client credentials are issued per app - contact support@clipform.io.
      flows:
        authorizationCode:
          authorizationUrl: https://api.clipform.io/oauth/authorize
          tokenUrl: https://api.clipform.io/oauth/token
          refreshUrl: https://api.clipform.io/oauth/token
          scopes:
            forms:read: Read the workspace's forms.
            responses:read: Read the workspace's form responses.
            webhooks:manage: Subscribe and unsubscribe webhook endpoints.
x-refined-from:
- api.clipform.io_openapi.json
- clipform-io-openapi.yml