> 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 # QueryIntakeFormSubmissions # Package: intakeForms # Namespace: IntakeFormSubmissionsService # Method link: https://dev.wix.com/docs/api-reference/crm/forms/other-services/intake-forms/intake-form-submissions/query-intake-form-submissions.md ## Permission Scopes: Read Intake Form: SCOPE.INTAKE-FORM.READ ## Introduction Retrieves a list of intake form submissions, given the provided paging, filtering, and sorting. Submissions belonging to deleted intake forms aren't returned by Query Intake Form Submissions. Query Intake Form Submissions runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order. - `paging.limit` is `50`. - `paging.offset` is `0`. Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). --- ## REST API ### Schema ``` Method: queryIntakeFormSubmissions Description: Retrieves a list of intake form submissions, given the provided paging, filtering, and sorting. Submissions belonging to deleted intake forms aren't returned by Query Intake Form Submissions. Query Intake Form Submissions runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order. - `paging.limit` is `50`. - `paging.offset` is `0`. Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). URL: https://www.wixapis.com/intake-forms/v1/intake-form-submissions/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryIntakeFormSubmissionsResponse - name: intakeFormSubmissions | type: array | description: Retrieved intake form submissions. - 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: 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: 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. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query intake form submissions ```curl curl -X POST \ 'https://www.wixapis.com/intake-form-submissions/v1/intake-form-submissions/query' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "query": { "filter": { "createdDate": {"$gte": "2024-01-01T00:00:00.000Z"} }, "sort": [ { "fieldName": "createdDate", "order": "DESC" } ], "paging": { "limit": 50 } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.intakeForms.IntakeFormSubmissionsService.queryIntakeFormSubmissions(query) Description: Retrieves a list of intake form submissions, given the provided paging, filtering, and sorting. Submissions belonging to deleted intake forms aren't returned by Query Intake Form Submissions. Query Intake Form Submissions runs with these defaults, which you can override: - `createdDate` is sorted in `DESC` order. - `paging.limit` is `50`. - `paging.offset` is `0`. Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: IntakeFormSubmissionQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: intakeFormSubmissions | type: array | description: Retrieved intake form submissions. - 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: _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: _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. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryIntakeFormSubmissions ```javascript import { intakeFormSubmissions } from '@wix/intake-forms'; async function queryIntakeFormSubmissions(query) { const response = await intakeFormSubmissions.queryIntakeFormSubmissions(query); }; ``` ### queryIntakeFormSubmissions (with elevated permissions) ```javascript import { intakeFormSubmissions } from '@wix/intake-forms'; import { auth } from '@wix/essentials'; async function myQueryIntakeFormSubmissionsMethod(query) { const elevatedQueryIntakeFormSubmissions = auth.elevate(intakeFormSubmissions.queryIntakeFormSubmissions); const response = await elevatedQueryIntakeFormSubmissions(query); } ``` ### queryIntakeFormSubmissions (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 queryIntakeFormSubmissions(query) { const response = await myWixClient.intakeFormSubmissions.queryIntakeFormSubmissions(query); }; ``` ---