> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListIntakeFormDataByContacts # Package: intakeForms # Namespace: IntakeFormSubmissionsService # Method link: https://dev.wix.com/docs/api-reference/crm/forms/other-services/intake-forms/intake-form-submissions/list-intake-form-data-by-contacts.md ## Permission Scopes: Read Intake Form: SCOPE.INTAKE-FORM.READ ## Introduction Retrieves intake form data for specified contacts. Returns both intake forms without submissions and the most recent submission per contact and form ID. If you include a deleted intake form ID in the request, that form is omitted from the response. Call this method to see which forms each contact has submitted and which they haven't. You can use it for a single contact or many at once. --- ## REST API ### Schema ``` Method: listIntakeFormDataByContacts Description: Retrieves intake form data for specified contacts. Returns both intake forms without submissions and the most recent submission per contact and form GUID. If you include a deleted intake form GUID in the request, that form is omitted from the response. Call this method to see which forms each contact has submitted and which they haven't. You can use it for a single contact or many at once. URL: https://www.wixapis.com/intake-forms/v1/intake-form-submissions Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: contactInfo Method parameters: param name: contactInfo | type: array | description: Contacts to retrieve intake form data for. | required: true - ONE-OF: - name: contactId | type: string | description: Contact GUID. - name: email | type: string | description: Contact's email address. param name: intakeFormIds | type: array | description: Optional filter. List of intake form GUIDs to limit results to. Return type: ListIntakeFormDataByContactsResponse - name: contactIntakeFormData | type: array | description: Intake form data per contact. - name: contactInfo | type: ContactInfo | description: Contact information. - ONE-OF: - name: contactId | type: string | description: Contact GUID. - name: email | type: string | description: Contact's email address. - name: intakeFormData | type: array | description: Intake form data for the contact. - ONE-OF: - name: intakeFormInfo | type: IntakeFormInfo | description: Intake form information. Returned when the contact hasn't submitted the form. - name: id | type: string | description: Intake form GUID. - name: name | type: string | description: Intake form name. - name: expirationPeriodInMonths | type: integer | description: Expiration period in months for the intake form. - name: archived | type: boolean | description: Whether the intake form is archived. - name: mostRecentSubmission | type: IntakeFormSubmission | description: Most recent intake form submission. Returned when the contact has submitted the form. - name: id | type: string | description: Intake form submission GUID. Identical to the [Wix Forms form submission GUID](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/submission-object.md). - name: createdDate | type: string | description: Date and time the intake form submission was created in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. - name: revision | type: string | description: Revision number, which increments by 1 each time the intake form submission is updated. To prevent conflicting changes, you must specify the current revision when updating the intake form submission. - name: signer | type: Signer | description: Information about the person who submitted the intake form. - name: contactId | type: string | description: [Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/introduction.md) GUID. - name: fullName | type: string | description: Contact's full name. - name: email | type: string | description: Contact's email address. - name: submitter | type: Submitter | description: Whether the form was submitted by the customer directly or by the business on the customer's behalf. - enum: - CUSTOMER: Customer submitted the form themselves. - BUSINESS: Business owner or staff submitted the form on behalf of the customer. - name: status | type: Status | description: Submission status. - enum: - VALID: Submission is valid and hasn't expired. - EXPIRED: Submission has expired. The business must extend the submission or the contact must resubmit the form. - CANCELED: Submission was canceled. The contact must resubmit the form. - EXTENDED: The business has manually extended the submission's validity. - EXEMPT: The business has manually exempted the customer from submitting the form. - name: expirationDate | type: string | description: Date and time when the submission expires in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. Calculated from `createdDate` plus the intake form's `expirationPeriodInMonths`. You can manually extend the expiration date. - name: intakeFormInfo | type: IntakeFormInfo | description: Intake form information. Returned only when `INTAKE_FORM_INFO` is requested in the `fields` parameter. - name: updatedDate | type: string | description: Date and time the submission status was manually updated (canceled or extended) in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. Possible Errors: HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: UNAUTHORIZED_CONTACT_ACCESS | Description: The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md) used to call the method doesn't have the required permissions. ``` ### Examples ### List intake form data by contacts ```curl curl -X POST \ 'https://www.wixapis.com/intake-form-submissions/v1/intake-form-submissions' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "contactInfo": [ { "contactId": "770e8400-e29b-41d4-a716-446655440002" }, { "email": "jane.smith@example.com" } ], "intakeFormIds": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.intakeForms.IntakeFormSubmissionsService.listIntakeFormDataByContacts(contactInfo, options) Description: Retrieves intake form data for specified contacts. Returns both intake forms without submissions and the most recent submission per contact and form GUID. If you include a deleted intake form GUID in the request, that form is omitted from the response. Call this method to see which forms each contact has submitted and which they haven't. You can use it for a single contact or many at once. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: contactInfo Method parameters: param name: contactInfo | type: array | description: Contacts to retrieve intake form data for. | required: true - ONE-OF: - name: contactId | type: string | description: Contact GUID. - name: email | type: string | description: Contact's email address. param name: options | type: ListIntakeFormDataByContactsOptions none - name: intakeFormIds | type: array | description: Optional filter. List of intake form GUIDs to limit results to. Return type: PROMISE - name: contactIntakeFormData | type: array | description: Intake form data per contact. - name: contactInfo | type: ContactInfo | description: Contact information. - ONE-OF: - name: contactId | type: string | description: Contact GUID. - name: email | type: string | description: Contact's email address. - name: intakeFormData | type: array | description: Intake form data for the contact. - ONE-OF: - name: intakeFormInfo | type: IntakeFormInfo | description: Intake form information. Returned when the contact hasn't submitted the form. - name: _id | type: string | description: Intake form GUID. - name: name | type: string | description: Intake form name. - name: expirationPeriodInMonths | type: integer | description: Expiration period in months for the intake form. - name: archived | type: boolean | description: Whether the intake form is archived. - name: mostRecentSubmission | type: IntakeFormSubmission | description: Most recent intake form submission. Returned when the contact has submitted the form. - name: _id | type: string | description: Intake form submission GUID. Identical to the [Wix Forms form submission GUID](https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/submission-object.md). - name: _createdDate | type: Date | description: Date and time the intake form submission was created in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. - name: revision | type: string | description: Revision number, which increments by 1 each time the intake form submission is updated. To prevent conflicting changes, you must specify the current revision when updating the intake form submission. - name: signer | type: Signer | description: Information about the person who submitted the intake form. - name: contactId | type: string | description: [Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/introduction.md) GUID. - name: fullName | type: string | description: Contact's full name. - name: email | type: string | description: Contact's email address. - name: submitter | type: Submitter | description: Whether the form was submitted by the customer directly or by the business on the customer's behalf. - enum: - CUSTOMER: Customer submitted the form themselves. - BUSINESS: Business owner or staff submitted the form on behalf of the customer. - name: status | type: Status | description: Submission status. - enum: - VALID: Submission is valid and hasn't expired. - EXPIRED: Submission has expired. The business must extend the submission or the contact must resubmit the form. - CANCELED: Submission was canceled. The contact must resubmit the form. - EXTENDED: The business has manually extended the submission's validity. - EXEMPT: The business has manually exempted the customer from submitting the form. - name: expirationDate | type: Date | description: Date and time when the submission expires in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. Calculated from `createdDate` plus the intake form's `expirationPeriodInMonths`. You can manually extend the expiration date. - name: intakeFormInfo | type: IntakeFormInfo | description: Intake form information. Returned only when `INTAKE_FORM_INFO` is requested in the `fields` parameter. - name: _updatedDate | type: Date | description: Date and time the submission status was manually updated (canceled or extended) in UTC datetime `YYYY-MM-DDThh:mm:ssZ` format. Possible Errors: HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: UNAUTHORIZED_CONTACT_ACCESS | Description: The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md) used to call the method doesn't have the required permissions. ``` ### Examples ### listIntakeFormDataByContacts ```javascript import { intakeFormSubmissions } from '@wix/intake-forms'; async function listIntakeFormDataByContacts(contactInfo,options) { const response = await intakeFormSubmissions.listIntakeFormDataByContacts(contactInfo,options); }; ``` ### listIntakeFormDataByContacts (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { intakeFormSubmissions } from '@wix/intake-forms'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { intakeFormSubmissions }, // Include the auth strategy and host as relevant }); async function listIntakeFormDataByContacts(contactInfo,options) { const response = await myWixClient.intakeFormSubmissions.listIntakeFormDataByContacts(contactInfo,options); }; ``` ---