Crevio Form Submissions API

openapi: 3.2.0
info:
  title: Crevio API V1 Form Submissions API
  version: 1.0.0
  description: 'API for the Crevio creator platform — a multi-tenant SaaS for digital product sales.

    Uses snake_case keys following Stripe conventions. All resource IDs are string IDs (e.g., "prod_abc123").


    Authentication is a bearer token: `Authorization: Bearer $CREVIO_API_KEY`.

    List endpoints are cursor-paginated with `limit` and `starting_after`.

    Writes accept an `Idempotency-Key` header and are safe to retry.


    Every response carries IETF RateLimit headers (`RateLimit`, `RateLimit-Policy`) so a client can

    self-throttle, and `Retry-After` on a 429. The quota is 600 requests per minute per credential.


    The API is versioned in the URL path (`/v1`). Nothing is removed without in-band warning: a

    deprecated operation is marked `"deprecated": true` here and serves `Deprecation` (RFC 9745),

    `Sunset` (RFC 8594) and `Link; rel="deprecation"` headers for at least six months before it

    stops answering. See https://crevio.co/docs/developer/guides/versioning.'
  contact:
    email: support@crevio.co
    name: Crevio Support
    url: https://crevio.co/docs
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://crevio.co/legal/terms-of-service
servers:
- url: https://api.crevio.co/v1
  description: Production
security:
- ApiKey: []
tags:
- name: FormSubmissions
  description: Form submission management
paths:
  /form_submissions:
    get:
      summary: List form submissions
      description: Returns a list of form submissions for the current account
      operationId: listFormSubmissions
      x-crevio-sdk-method: list
      tags:
      - FormSubmissions
      security:
      - ApiKey: []
      parameters:
      - name: respondent_type
        in: query
        description: Filter by respondent type
        schema:
          type: string
      - name: starting_after
        in: query
        description: Cursor for pagination — the ID of the last item in the previous page
        schema:
          type: string
      - name: limit
        in: query
        description: Items per page
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      responses:
        '200':
          description: List of form submissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse_FormSubmission'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: allow
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.formSubmissions.list({});\n\n  console.log(result);\n}\n\nrun();"
    post:
      summary: Create form submission
      description: Submits a response to a lead magnet form; creates the customer if needed and triggers delivery.
      operationId: createFormSubmission
      x-crevio-sdk-method: create
      tags:
      - FormSubmissions
      security:
      - ApiKey: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: 'Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.'
        schema:
          type: string
          maxLength: 255
        example: 1f7a4c2e-3b19-4a6d-9f0c-2ac81b5d7e33
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormSubmissionRequest'
      responses:
        '201':
          description: Form submission created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormSubmission'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: allow
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.formSubmissions.create({\n    formId: \"<id>\",\n    email: \"jane@example.com\",\n    answers: {\n      key: \"<value>\",\n    },\n  });\n\n  console.log(result);\n}\n\nrun();"
  /form_submissions/{id}:
    get:
      summary: Get form submission
      description: Returns a specific form submission
      operationId: getFormSubmission
      x-crevio-sdk-method: get
      tags:
      - FormSubmissions
      security:
      - ApiKey: []
      parameters:
      - name: id
        in: path
        required: true
        description: The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")
        schema:
          type: string
      responses:
        '200':
          description: Form submission details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormSubmission'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: allow
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.formSubmissions.get({\n    id: \"<id>\",\n  });\n\n  console.log(result);\n}\n\nrun();"
    delete:
      summary: Delete form submission
      description: Permanently deletes a form submission and its answers. This cannot be undone.
      operationId: deleteFormSubmission
      x-crevio-sdk-method: delete
      tags:
      - FormSubmissions
      security:
      - ApiKey: []
      parameters:
      - name: id
        in: path
        required: true
        description: The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")
        schema:
          type: string
      responses:
        '200':
          description: Form submission deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: ask
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.formSubmissions.delete({\n    id: \"<id>\",\n  });\n\n  console.log(result);\n}\n\nrun();"
webhooks:
  form_submission.created:
    post:
      tags:
      - FormSubmissions
      summary: Form submission created
      description: Triggered when a form submission is received
      operationId: webhookFormSubmissionCreated
      security: []
      parameters:
      - name: webhook-id
        in: header
        required: true
        description: The event's id, identical on every retry and equal to `id` in the body. Store it to ignore a delivery you have already handled.
        schema:
          type: string
      - name: webhook-timestamp
        in: header
        required: true
        description: Unix seconds when this attempt was sent. Reject anything older than five minutes.
        schema:
          type: string
      - name: webhook-signature
        in: header
        required: true
        description: '`v1,<signature>`, per the Standard Webhooks specification: the base64 HMAC-SHA256 of `<webhook-id>.<webhook-timestamp>.<raw request body>`, keyed with the bytes your `whsec_` secret encodes. Verify it with a Standard Webhooks library before processing the event.'
        schema:
          type: string
      requestBody:
        description: Event payload Crevio POSTs to your endpoint.
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique identifier for this webhook event
                  example: whev_abc123
                object:
                  type: string
                  enum:
                  - event
                  example: event
                type:
                  type: string
                  enum:
                  - form_submission.created
                  description: The event type
                  example: form_submission.created
                livemode:
                  type: boolean
                  description: '`false` when a test purchase or a test event from the dashboard caused this event, `true` otherwise'
                  example: true
                created_at:
                  type: string
                  format: date-time
                  description: ISO 8601 timestamp of when the event was created
                  example: '2025-01-15T10:30:00Z'
                api_version:
                  type: string
                  description: API version used to generate the payload
                  example: v1
                data:
                  type: object
                  description: '`object` is the resource exactly as its API endpoint returns it.'
                  properties:
                    object:
                      $ref: '#/components/schemas/FormSubmission'
                  required:
                  - object
              required:
              - id
              - object
              - type
              - livemode
              - created_at
              - api_version
              - data
      responses:
        '200':
          description: Return any 2xx status within 5 seconds to acknowledge receipt.
  form_submission.confirmed:
    post:
      tags:
      - FormSubmissions
      summary: Form submission confirmed
      description: Triggered when a pending form submission is confirmed via double opt-in
      operationId: webhookFormSubmissionConfirmed
      security: []
      parameters:
      - name: webhook-id
        in: header
        required: true
        description: The event's id, identical on every retry and equal to `id` in the body. Store it to ignore a delivery you have already handled.
        schema:
          type: string
      - name: webhook-timestamp
        in: header
        required: true
        description: Unix seconds when this attempt was sent. Reject anything older than five minutes.
        schema:
          type: string
      - name: webhook-signature
        in: header
        required: true
        description: '`v1,<signature>`, per the Standard Webhooks specification: the base64 HMAC-SHA256 of `<webhook-id>.<webhook-timestamp>.<raw request body>`, keyed with the bytes your `whsec_` secret encodes. Verify it with a Standard Webhooks library before processing the event.'
        schema:
          type: string
      requestBody:
        description: Event payload Crevio POSTs to your endpoint.
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: Unique identifier for this webhook event
                  example: whev_abc123
                object:
                  type: string
                  enum:
                  - event
                  example: event
                type:
                  type: string
                  enum:
                  - form_submission.confirmed
                  description: The event type
                  example: form_submission.confirmed
                livemode:
                  type: boolean
                  description: '`false` when a test purchase or a test event from the dashboard caused this event, `true` otherwise'
                  example: true
                created_at:
                  type: string
                  format: date-time
                  description: ISO 8601 timestamp of when the event was created
                  example: '2025-01-15T10:30:00Z'
                api_version:
                  type: string
                  description: API version used to generate the payload
                  example: v1
                data:
                  type: object
                  description: '`object` is the resource exactly as its API endpoint returns it.'
                  properties:
                    object:
                      $ref: '#/components/schemas/FormSubmission'
                  required:
                  - object
              required:
              - id
              - object
              - type
              - livemode
              - created_at
              - api_version
              - data
      responses:
        '200':
          description: Return any 2xx status within 5 seconds to acknowledge receipt.
components:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: forbidden
              message: You do not have permission to perform this action
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: bad_request
              message: The request was malformed or contained invalid parameters
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: authentication_required
              message: You did not provide an API key.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: resource_missing
              message: The requested resource was not found
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    TooManyRequests:
      description: 'Rate limit exceeded — 600 requests per minute per owner on the free tier: every API key and OAuth token one person holds on an account shares one budget, and the account''s team keys share another. Retry after the number of seconds in `Retry-After`.'
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: rate_limit_exceeded
              message: Too many requests. Please retry later.
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: api_error
              code: internal_error
              message: An unexpected error occurred
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    UnprocessableEntity:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: validation_error
              code: validation_failed
              message: Email is required
              errors:
                email:
                - can't be blank
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
  schemas:
    DeleteResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        deleted:
          type: boolean
          enum:
          - true
      required:
      - id
      - object
      - deleted
    ListResponse_FormSubmission:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/FormSubmission'
        has_more:
          type: boolean
        url:
          type: string
      required:
      - object
      - data
      - has_more
      - url
    FormSubmissionRequest:
      type: object
      properties:
        form_id:
          type: string
          description: Form ID being submitted
        email:
          type: string
          description: Respondent email address. Used to upsert a Customer and, as a convenience, auto-fills the form's email field if no answer is provided for it.
        name:
          type:
          - string
          - 'null'
          description: Respondent name (defaults to email local-part if omitted). Auto-fills the form's first text field when present and not otherwise supplied via `answers`.
        answers:
          type: object
          additionalProperties: true
          description: Map of form_field id → answer value. Optional for simple email-only forms — pass `{}` and rely on the `email` auto-fill. A `consent` field takes `true` when the person ticked it.
        ip_address:
          type:
          - string
          - 'null'
          description: The submitter's IP address, kept with the submission as a record of the signup.
      required:
      - form_id
      - email
      - answers
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - api_error
              - invalid_request_error
              - validation_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            errors:
              type: object
            doc_url:
              type: string
          required:
          - type
          - message
      required:
      - error
    FormSubmission:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        answers:
          type: array
          items:
            type: object
            properties:
              field_type:
                type: string
              label:
                type: string
              required:
                type: boolean
              value:
                oneOf:
                - type: string
                - type: array
                  items:
                    type: string
                - type: boolean
                - type: 'null'
                description: A `consent` answer is `true` when the person ticked it.
              options:
                type: array
                items:
                  type: string
            required:
            - field_type
            - label
            - required
            - value
        respondent_type:
          type: string
        confirmation_requested_at:
          type:
          - string
          - 'null'
          format: date-time
        confirmed_at:
          type:
          - string
          - 'null'
          format: date-time
        delivered_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        respondent_id:
          type: string
        form_id:
          type: string
      required:
      - id
      - object
      - answers
      - respondent_type
      - confirmation_requested_at
      - confirmed_at
      - delivered_at
      - created_at
      - respondent_id
      - form_id
  headers:
    Sunset:
      description: Present only on a deprecated operation. HTTP-date (RFC 8594) after which the operation stops responding. Always at least six months after `Deprecation`.
      schema:
        type: string
        examples:
        - Thu, 01 Oct 2026 00:00:00 GMT
    RequestId:
      description: Unique id for this request. Quote it when reporting a problem.
      schema:
        type: string
        examples:
        - 8fe045fe-cb8a-4407-a44d-5df60385e522
    DeprecationLink:
      description: Present only on a deprecated operation. `<url>; rel="deprecation"` pointing at the migration notes.
      schema:
        type: string
        examples:
        - <https://crevio.co/docs/developer/guides/versioning>; rel="deprecation"
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        examples:
        - 11
    Deprecation:
      description: Present only on a deprecated operation. Structured-field date (RFC 9745) — `@` followed by the Unix timestamp at which the operation became deprecated.
      schema:
        type: string
        examples:
        - '@1775001600'
    RateLimit:
      description: 'Remaining quota for the current window, as an IETF structured field: `"default";r=<remaining>;t=<seconds until reset>`.'
      schema:
        type: string
        examples:
        - '"default";r=596;t=11'
    RateLimitPolicy:
      description: 'The quota this credential is subject to: `"default";q=<requests>;w=<window seconds>`.'
      schema:
        type: string
        examples:
        - '"default";q=600;w=60'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key in the format: Bearer {api_token}'
externalDocs:
  description: Crevio developer documentation
  url: https://crevio.co/docs/developer
x-mint:
  mcp:
    enabled: true
x-api-lifecycle:
  current_major_version: v1
  versioning_scheme: URL path
  deprecation_policy_url: https://crevio.co/docs/developer/guides/versioning
  minimum_notice_days: 183
  deprecation_headers:
  - Deprecation
  - Sunset
  - Link