About the Intake Forms API

The Intake Forms API lets you create and manage AI-generated client intake forms. An intake form gathers project information from a partner's client, for example the client's name, their project details, and their answers to a tailored questionnaire, so the partner can kick off work with everything they need.

An intake form wraps a questionnaire with project context, the AI-generated background material used to tailor it, the client the form is shared with, and the submission state. The questionnaire is generated with AI the first time the form is opened.

With the Intake Forms API, you can:

• Create, retrieve, update, and delete intake forms, including in bulk.
• Query and search intake forms across a partner's account, for example to export all submitted forms to an external system or to power an AI assistant that works with a partner's own data.
• Store AI-generated context and the source materials used to generate a form's questionnaire.
• Share a form with one or more clients and track when it was first shared and when it was submitted.
• Notify team members through Wix Automations when a client submits a form or adds a note to it.
• View an intake form and manage its lifecycle in Content Collector at https://www.wix.com/content-collector/partner/{intakeFormId}.

Finding intake forms

The API provides two ways to find intake forms in a partner's account:

• Query Intake Forms is for precise structured filtering and sorting. Use it when you know exactly which forms you want, for example to export forms ordered by submission.submittedDate.
• Search Intake Forms matches a free-text expression against the client name and project name, and supports filtering, sorting, and aggregations. Use it for keyword lookup, for example to find the forms for a client a user asked about.

Both are scoped to the caller's account.

Before you begin

It's important to note the following points before starting to code:

• The questionnaire is generated with AI the first time the form is opened. The Content Collector app generates the questionnaire and stores the resulting context. This API stores the generated content but doesn't perform the generation itself.
• Submission state is populated asynchronously. submission.submittedDate and submission.lastEditDate appear on the intake form after the client submits and the submission is processed, so they may be empty until then.
• Reads and writes are scoped to the caller's account. GetIntakeForm, UpdateIntakeForm, DeleteIntakeForm, QueryIntakeForms, and SearchIntakeForms only operate on intake forms in the caller's account. A valid ID belonging to another account reads as not found.
• Deleting an intake form is permanent. DeleteIntakeForm also deletes the generated questionnaire behind the form. This is irreversible.
• Clients are Wix-authenticated. A client retrieves their form with GetClientIntakeForm only if their signed-in email address is one of the form's clientEmails.

Use cases

• Create an intake form and share it with a client
• Export submitted intake forms to an external system
• Find a client's intake forms for an AI assistant

Terminology

• Intake form: The entity managed by this API. It wraps a questionnaire with project context, source materials, the clients it's shared with, and submission state.
• Client: The partner's customer, who fills out the form. Identified by the email addresses in clientEmails.
• Submission: The state of the client's response, reflected on the intake form through submission (for example, submittedDate).
• Context: AI-generated background text used to tailor the questionnaire, stored on the intake form.
• Source materials: The partner-provided inputs (project description, uploaded files, an existing questionnaire) used to generate the form.