Harvis

Harvis Submissions API

What visitors typed into a .

GitHub OpenAPI

Operations 7

DELETE /api/v1/sites/{id}/submissions Delete every submission for a site, or every one of a single form #
GET /api/v1/sites/{id}/submissions One page of a site's form submissions, newest first #
DELETE /api/v1/sites/{id}/submissions/{submissionId} Delete one submission #
GET /api/v1/sites/{id}/submissions/{submissionId} One submission #
GET /api/v1/sites/{id}/submissions/csv Export a site's form submissions as CSV #
POST /api/v1/sites/{id}/submissions/read Mark every unread submission as read #
GET /api/v1/sites/{id}/submissions/summary How many submissions a site holds, how many are unread, and which forms exist #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/harvis-dev/openapi/harvis-dev-submissions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/harvis-dev/json-schema/harvis-dev-submission-summary-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/harvis-dev:harvis-dev-submissions-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.

GitHub Google LinkedIn

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

OpenAPI Specification

harvis-dev-submissions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: harvis.dev Submissions API
  version: '1'
  description: Everything an account can control, over HTTP. This document is generated from lib/api/contract.ts, which is also what the dashboard's server actions call — so what the harvis CLI can do and what the web app can do are the same list by construction. Do not edit this file by hand; run `bun run api:generate`.
servers:
- url: https://harvis.dev
tags:
- name: Submissions
  description: What visitors typed into a .
paths:
  /api/v1/sites/{id}/submissions:
    delete:
      operationId: submissions.deleteAll
      summary: Delete every submission for a site, or every one of a single form
      tags:
      - Submissions
      security:
      - apiKey: []
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: form
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Delete every submission for a site, or every one of a single form.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedResult'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`suspended`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`siteNotFound`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    get:
      operationId: submissions.list
      summary: One page of a site's form submissions, newest first
      tags:
      - Submissions
      security:
      - apiKey: []
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: form
        in: query
        required: false
        description: Restrict to one harvis-form name.
        schema:
          type: string
      - name: offset
        in: query
        required: false
        description: Rows to skip. The page size is 50.
        schema:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      responses:
        '200':
          description: One page of a site's form submissions, newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionList'
        '400':
          description: '`invalidRequest`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`suspended`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`siteNotFound`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /api/v1/sites/{id}/submissions/{submissionId}:
    delete:
      operationId: submissions.delete
      summary: Delete one submission
      tags:
      - Submissions
      security:
      - apiKey: []
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: submissionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Delete one submission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResult'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`suspended`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`siteNotFound`, `submissionNotFound`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    get:
      operationId: submissions.get
      summary: One submission
      tags:
      - Submissions
      security:
      - apiKey: []
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: submissionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: One submission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionResult'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`suspended`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`siteNotFound`, `submissionNotFound`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /api/v1/sites/{id}/submissions/csv:
    get:
      operationId: submissions.csv
      summary: Export a site's form submissions as CSV
      tags:
      - Submissions
      security:
      - apiKey: []
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: form
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: One column per field anyone ever submitted, in first-seen order, sent as an attachment named <subdomain>-<form>.csv. Values beginning =, +, - or @ are quote-prefixed so a spreadsheet does not execute visitor-supplied text as a formula.
          content:
            text/csv:
              schema:
                type: string
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`suspended`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`siteNotFound`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /api/v1/sites/{id}/submissions/read:
    post:
      operationId: submissions.markRead
      summary: Mark every unread submission as read
      tags:
      - Submissions
      security:
      - apiKey: []
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Mark every unread submission as read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OkResult'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`suspended`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`siteNotFound`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /api/v1/sites/{id}/submissions/summary:
    get:
      operationId: submissions.summary
      summary: How many submissions a site holds, how many are unread, and which forms exist
      tags:
      - Submissions
      security:
      - apiKey: []
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: How many submissions a site holds, how many are unread, and which forms exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionSummary'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`suspended`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`siteNotFound`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    SubmissionSummary:
      type: object
      properties:
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        unread:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        forms:
          description: Distinct harvis-form names seen on this site.
          type: array
          items:
            type: string
      required:
      - total
      - unread
      - forms
      additionalProperties: false
    Submission:
      type: object
      properties:
        id:
          type: string
        formName:
          description: The value of the harvis-form attribute; a bare attribute is 'default'.
          type: string
        data:
          description: Field name to value, exactly as the visitor's browser sent it.
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: string
        pagePath:
          anyOf:
          - type: string
          - type: 'null'
        readAt:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
        createdAt:
          format: date-time
          type: string
      required:
      - id
      - formName
      - data
      - pagePath
      - readAt
      - createdAt
      additionalProperties: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              description: A stable machine code — see docs/api.md for the full list.
              type: string
            message:
              description: English prose, for a human reading a log.
              type: string
          required:
          - code
          - message
          additionalProperties: false
      required:
      - error
      additionalProperties: false
    OkResult:
      type: object
      properties:
        ok:
          type: boolean
          const: true
      required:
      - ok
      additionalProperties: false
    SubmissionResult:
      type: object
      properties:
        submission:
          $ref: '#/components/schemas/Submission'
      required:
      - submission
      additionalProperties: false
    SubmissionList:
      type: object
      properties:
        submissions:
          type: array
          items:
            $ref: '#/components/schemas/Submission'
        hasMore:
          description: Whether another page follows this one.
          type: boolean
      required:
      - submissions
      - hasMore
      additionalProperties: false
    DeletedResult:
      type: object
      properties:
        ok:
          type: boolean
          const: true
        removed:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
      - ok
      - removed
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: hvs_…
      description: An account key, created at https://harvis.dev/dashboard/keys and shown once.
    session:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: The dashboard's own sign-in cookie. Listed because the browser calls these same endpoints; a CLI or a server should use apiKey instead.