> 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

# QuerySubmissionsByNamespace

# Package: forms

# Namespace: FormSubmissionService

# Method link: https://dev.wix.com/docs/api-reference/crm/forms/form-submissions/query-submissions-by-namespace.md

## Permission Scopes:
Read Submissions: SCOPE.DC-FORMS.READ-SUBMISSIONS

## Introduction

> **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance.md) to confirm that the app named `wix_forms` is installed on the site.
<br>

Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.

You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.

To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).

---

## REST API

### Schema

```
 Method: querySubmissionsByNamespace
 Description: > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance.md) to confirm that the app named `wix_forms` is installed on the site. <br>  Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.  You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.  To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
 URL: https://www.wixapis.com/v4/submissions/namespace/query
 Method: POST
 # 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: onlyYourOwn | type: onlyYourOwn | description: Whether to return only your own submissions. If `false`, returns all submissions based on query filters. 
   param name: query | type: CursorQuery   | required: true
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Number of items to load. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  You can get 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 in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: QuerySubmissionsByNamespaceResponse
  - name: submissions | type: array<FormSubmission> | description: The retrieved Submissions. 
     - name: id | type: string | description: Submission GUID. 
     - name: formId | type: string | description: GUID of the form which the submission belongs to. 
     - name: namespace | type: string | description: The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace. 
     - name: status | type: SubmissionStatus | description: Status of the submission. 
         - enum:
         -     PENDING: A submission is created, but has not yet been recorded in the Wix Forms collection.
         -     CONFIRMED: A submission is recorded in the Wix Forms collection.
         -     PAYMENT_WAITING: A form submission requiring payment is created.
         -     PAYMENT_CANCELED: An order of a form submission is canceled.
     - name: submissions | type: Map<string,Value> | description: Submission values where `key` is the form field and `value` is the data submitted for the given field. 
        - ONE-OF: 
           - name: nullValue | type:  | description:  
           - name: numberValue | type: number | description:  
           - name: stringValue | type: string | description:  
           - name: boolValue | type: boolean | description:  
           - name: structValue | type: object | description:  
           - name: listValue | type: ListValue | description:  
              - name: values | type: array<Value> | description:  
     - name: createdDate | type: string | description: Date and time the form submission was created. 
     - name: updatedDate | type: string | description: Date and time the form submission was updated. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission. 
     - name: submitter | type: Submitter | description: GUID of the visitor that submitted the form. 
        - ONE-OF: 
           - name: memberId | type: string | description: Member GUID. 
           - name: visitorId | type: string | description: Visitor GUID. 
           - name: applicationId | type: string | description: Application GUID. 
           - name: userId | type: string | description: User GUID. 
     - name: seen | type: boolean | description: Whether a site owner marked a submission as "seen". 
     - name: extendedFields | type: ExtendedFields | description: Data extension object that holds users' and apps' fields. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
     - name: orderDetails | type: OrderDetails | description: Order details. <br> <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app. 
        - name: orderId | type: string | description: GUID of the order related to submission (only applicable if a form has payments). 
        - name: number | type: string | description: Order number. 
        - name: currency | type: string | description: Currency. 
        - name: itemSubtotal | type: string | description: Item subtotal. 
        - name: checkoutId | type: string | description: GUID of the checkout related to submission (only applicable if a form has payments). 
     - name: contactId | type: string | description: Contact GUID of a site visitor who created the submission. 
     - name: accessRestriction | type: string | description: Authorized viewer GUID. 
     - name: tags | type: PublicTags | description: Tag GUIDs collections associated with the current entity. 
        - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
           - name: tagIds | type: array | description: List of tag GUIDs 
     - name: appointmentDetails | type: AppointmentDetails | description: Appointment details. This object is only applicable when submitting a form that creates a booking appointment. 
        - name: staffMemberId | type: string | description: GUID of the staff member assigned to the appointment. 
        - name: staffMemberName | type: string | description: Name of the staff member assigned to the appointment. 
  - name: metadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### QuerySubmissionsByNamespace
```curl
~~~cURL
curl -X POST \
  'http://www.wixapis.com/form-submission/v4/submissions/namespace/query' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>' \
  -d '{
    "query": {
      "filter": {
        "formId": "e62e3011-55cf-4de3-a497-e097b52d86b8",
        "namespace": "wix.form_app.form"
      }
    },
    "onlyYourOwn": true
  }'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.forms.FormSubmissionService.querySubmissionsByNamespace(query, options)
 Description: > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance.md) to confirm that the app named `wix_forms` is installed on the site. <br>  Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.  You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.  To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
 # 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: options | type: QuerySubmissionsByNamespaceOptions  none 
        - name: onlyYourOwn | type: boolean | description: Whether to return only your own submissions. If `false`, returns all submissions based on query filters. 
   param name: query | type: SubmissionQuery   | required: true
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Number of items to load. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  You can get 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 in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - 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<QuerySubmissionsByNamespaceResponse>
  - name: submissions | type: array<FormSubmission> | description: The retrieved Submissions. 
     - name: _id | type: string | description: Submission GUID. 
     - name: formId | type: string | description: GUID of the form which the submission belongs to. 
     - name: namespace | type: string | description: The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace. 
     - name: status | type: SubmissionStatus | description: Status of the submission. 
         - enum:
         -     PENDING: A submission is created, but has not yet been recorded in the Wix Forms collection.
         -     CONFIRMED: A submission is recorded in the Wix Forms collection.
         -     PAYMENT_WAITING: A form submission requiring payment is created.
         -     PAYMENT_CANCELED: An order of a form submission is canceled.
     - name: submissions | type: Map<string,Value> | description: Submission values where `key` is the form field and `value` is the data submitted for the given field. 
        - ONE-OF: 
           - name: nullValue | type:  | description:  
           - name: numberValue | type: number | description:  
           - name: stringValue | type: string | description:  
           - name: boolValue | type: boolean | description:  
           - name: structValue | type: object | description:  
           - name: listValue | type: ListValue | description:  
              - name: values | type: array<Value> | description:  
     - name: _createdDate | type: Date | description: Date and time the form submission was created. 
     - name: _updatedDate | type: Date | description: Date and time the form submission was updated. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission. 
     - name: submitter | type: Submitter | description: GUID of the visitor that submitted the form. 
        - ONE-OF: 
           - name: memberId | type: string | description: Member GUID. 
           - name: visitorId | type: string | description: Visitor GUID. 
           - name: applicationId | type: string | description: Application GUID. 
           - name: userId | type: string | description: User GUID. 
     - name: seen | type: boolean | description: Whether a site owner marked a submission as "seen". 
     - name: extendedFields | type: ExtendedFields | description: Data extension object that holds users' and apps' fields. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
     - name: orderDetails | type: OrderDetails | description: Order details. <br> <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app. 
        - name: orderId | type: string | description: GUID of the order related to submission (only applicable if a form has payments). 
        - name: number | type: string | description: Order number. 
        - name: currency | type: string | description: Currency. 
        - name: itemSubtotal | type: string | description: Item subtotal. 
        - name: checkoutId | type: string | description: GUID of the checkout related to submission (only applicable if a form has payments). 
     - name: contactId | type: string | description: Contact GUID of a site visitor who created the submission. 
     - name: accessRestriction | type: string | description: Authorized viewer GUID. 
     - name: tags | type: PublicTags | description: Tag GUIDs collections associated with the current entity. 
        - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. 
           - name: tagIds | type: array | description: List of tag GUIDs 
     - name: appointmentDetails | type: AppointmentDetails | description: Appointment details. This object is only applicable when submitting a form that creates a booking appointment. 
        - name: staffMemberId | type: string | description: GUID of the staff member assigned to the appointment. 
        - name: staffMemberName | type: string | description: Name of the staff member assigned to the appointment. 
  - name: metadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### Query submissions by namespace (with elevated permissions)
```javascript
import { submissions } from '@wix/forms';
import { auth } from '@wix/essentials';

const elevatedQuerySubmissionsByNamespace = auth.elevate(submissions.querySubmissionsByNamespace);

export async function myQuerySubmissionsByNamespaceFunction() {
  try {
    const items = await elevatedQuerySubmissionsByNamespace()
      .eq('namespace', 'wix.form_app.form')
      .find()
    console.log('Success! Submissions:', items);
      return items
  } catch (error) {
      console.error(error)
  }
}

/* Promise resolves to:
[
    {
        "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
        "namespace": "wix.form_app.form",
        "status": "CONFIRMED",
        "submissions": {
            "last_name": "Doe",
            "first_name": "John"
        },
        "revision": "3",
        "submitter": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "seen": false,
        "_id": "abb9b5c9-a881-467c-9c34-b9bea43ca5f0",
        "_createdDate": "2023-12-28T12:54:04.652Z",
        "_updatedDate": "2023-12-28T12:54:05.483Z"
    },
    {
        "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
        "namespace": "wix.form_app.form",
        "status": "CONFIRMED",
        "submissions": {
            "last_name": "McBride",
            "first_name": "Patsy"
        },
        "revision": "3",
        "submitter": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "seen": false,
        "_id": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
        "_createdDate": "2023-12-28T12:55:55.630Z",
        "_updatedDate": "2023-12-28T12:55:56.233Z"
    }
]
*/
```

### Query submissions by namespace
```javascript
import { submissions } from '@wix/forms';

export async function myQuerySubmissionsByNamespaceFunction() {
  try {
    const items = await submissions.querySubmissionsByNamespace()
      .eq('namespace', 'wix.form_app.form')
      .find()
    console.log('Success! Submissions:', items);
      return items
  } catch (error) {
      console.error(error)
  }
}

/* Promise resolves to:
[
    {
        "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
        "namespace": "wix.form_app.form",
        "status": "CONFIRMED",
        "submissions": {
            "last_name": "Doe",
            "first_name": "John"
        },
        "revision": "3",
        "submitter": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "seen": false,
        "_id": "abb9b5c9-a881-467c-9c34-b9bea43ca5f0",
        "_createdDate": "2023-12-28T12:54:04.652Z",
        "_updatedDate": "2023-12-28T12:54:05.483Z"
    },
    {
        "formId": "21bcb6c7-02b3-4ed1-b6db-7856094fac03",
        "namespace": "wix.form_app.form",
        "status": "CONFIRMED",
        "submissions": {
            "last_name": "McBride",
            "first_name": "Patsy"
        },
        "revision": "3",
        "submitter": {
            "applicationId": "151e476a-715e-ec33-db9a-a7ff4d51f70a"
        },
        "seen": false,
        "_id": "f8281b62-1b2f-45bf-ba7d-f041d7653d2d",
        "_createdDate": "2023-12-28T12:55:55.630Z",
        "_updatedDate": "2023-12-28T12:55:56.233Z"
    }
]
*/
```

### querySubmissionsByNamespace (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 { submissions } from '@wix/forms';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { submissions },
  // Include the auth strategy and host as relevant
});


async function querySubmissionsByNamespace(query,options) {
  const response = await myWixClient.submissions.querySubmissionsByNamespace(query,options);
};
```

---