> 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

# QueryMarketingConsent

# Package: marketing

# Namespace: MarketingConsentService

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/marketing-consent/query-marketing-consent.md

## Permission Scopes:
Read Marketing Consents: SCOPE.DC-MARKETING.CONSENT-READ

## Introduction

Retrieves a list of marketing consents, given the provided paging, filtering, and sorting. Up to 100 marketing consents can be returned per request.

The default `sort` is `id` in `ASC` order. For a detailed list of supported operations, see filtering and sorting for marketing consent properties. To learn how to query marketing consents, see API Query Language.

---

## REST API

### Schema

```
 Method: queryMarketingConsent
 Description: Retrieves a list of marketing consents, given the provided paging, filtering, and sorting. Up to 100 marketing consents can be returned per request.  The default `sort` is `id` in `ASC` order. For a detailed list of supported operations, see filtering and sorting for marketing consent properties. To learn how to query marketing consents, see API Query Language.
 URL: https://www.wixapis.com/v1/marketing-consent/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: query | type: CursorQuery   | 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 [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). 
        - name: sort | type: array<Sorting> | description: Sort object.  Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: QueryMarketingConsentResponse
  - name: marketingConsent | type: array<MarketingConsent> | description: List of marketing consents. 
     - name: id | type: string | description: Marketing consent GUID. 
     - name: revision | type: string | description: Revision number. 
     - name: details | type: MarketingConsentDetails | description: Marketing consent communication details. 
        - ONE-OF: 
           - name: email | type: string | description: Email address used for the marketing consent. 
           - name: phone | type: string | description: Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. 
        - name: type | type: MarketingConsentDetailsIdentifierType | description: The communication channel of the marketing consent. 
             - enum: UNKNOWN_TYPE, EMAIL, PHONE
     - name: state | type: MarketingConsentState | description: Marketing consent state.  Default: `UNKNOWN_STATE`. 
         - enum:
         -     UNKNOWN_STATE: State of the marketing consent is unknown.
         -     NEVER_CONFIRMED: The site visitor never confirmed to receive marketing consents.
         -     REVOKED: The marketing consent has been removed, for example, when a site visitor unsubscribes from a newsletter.
         -     PENDING: The marketing consent is pending confirmation. Relevant only for `{"optInLevel": "DOUBLE_CONFIRMATION"}`.
         -     CONFIRMED: The site visitor has confirmed their marketing consent.
     - name: createdDate | type: string | description: Date and time the marketing consent was created. 
     - name: updatedDate | type: string | description: Date and time the marketing consent was updated. 
     - name: lastConfirmationActivity | type: LastConfirmationActivity | description: Last confirmation activity of the marketing consent. 
        - name: source | type: Source | description: Source of the given consent (how the site visitor signed up). 
             - enum: IN_PERSON, FORM, LINK_CONFIRMATION, EMAIL_SERVICE, WIX_USERS, OTHER
        - name: description | type: string | description: Consent description. 
        - name: updatedDate | type: string | description: Date and time the consent was updated. 
        - name: optInLevel | type: OptInLevel | description: Consent opt in level, either single or double confirmation. 
             - enum: UNKNOWN_OPT_IN_LEVEL, SINGLE_CONFIRMATION, DOUBLE_CONFIRMATION
     - name: lastRevokeActivity | type: LastRevokeActivity | description: Last revoke activity of the marketing consent. 
        - name: source | type: Source | description: Source of the given revoke (how the visitor signed up). 
             - enum: IN_PERSON, FORM, REVOKE_LINK, WIX_USERS, OTHER
        - name: description | type: string | description: Details about the revoke, if relevant. 
        - name: updatedDate | type: string | description: Date and time the consent was updated. 
     - name: extendedFields | type: ExtendedFields | description: Additional 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: pagingMetadata | type: CursorPagingMetadata | description: Details on the paged set of results returned. 
     - 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 Marketing Consent
```curl
curl -X POST \
  'https://www.wixapis.com/marketing-consent/v1/marketing-consent/query' \
  -H 'Authorization: <AUTH>' \
  -d '{
      "query": {
        "sort": [],
        "filter": {
          "details.email": "test@test.com"
        },
        "cursor_paging": {
          "limit": 1
        }
      }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.marketing.MarketingConsentService.queryMarketingConsent(query)
 Description: Retrieves a list of marketing consents, given the provided paging, filtering, and sorting. Up to 100 marketing consents can be returned per request.  The default `sort` is `id` in `ASC` order. For a detailed list of supported operations, see filtering and sorting for marketing consent properties. To learn how to query marketing consents, see API Query Language.
 # 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: MarketingConsentQuery   | 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 [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). 
        - name: sort | type: array<Sorting> | description: Sort object.  Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). 
           - 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<QueryMarketingConsentResponse>
  - name: marketingConsent | type: array<MarketingConsent> | description: List of marketing consents. 
     - name: _id | type: string | description: Marketing consent GUID. 
     - name: revision | type: string | description: Revision number. 
     - name: details | type: MarketingConsentDetails | description: Marketing consent communication details. 
        - ONE-OF: 
           - name: email | type: string | description: Email address used for the marketing consent. 
           - name: phone | type: string | description: Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. 
        - name: type | type: MarketingConsentDetailsIdentifierType | description: The communication channel of the marketing consent. 
             - enum: UNKNOWN_TYPE, EMAIL, PHONE
     - name: state | type: MarketingConsentState | description: Marketing consent state.  Default: `UNKNOWN_STATE`. 
         - enum:
         -     UNKNOWN_STATE: State of the marketing consent is unknown.
         -     NEVER_CONFIRMED: The site visitor never confirmed to receive marketing consents.
         -     REVOKED: The marketing consent has been removed, for example, when a site visitor unsubscribes from a newsletter.
         -     PENDING: The marketing consent is pending confirmation. Relevant only for `{"optInLevel": "DOUBLE_CONFIRMATION"}`.
         -     CONFIRMED: The site visitor has confirmed their marketing consent.
     - name: _createdDate | type: Date | description: Date and time the marketing consent was created. 
     - name: _updatedDate | type: Date | description: Date and time the marketing consent was updated. 
     - name: lastConfirmationActivity | type: LastConfirmationActivity | description: Last confirmation activity of the marketing consent. 
        - name: source | type: Source | description: Source of the given consent (how the site visitor signed up). 
             - enum: IN_PERSON, FORM, LINK_CONFIRMATION, EMAIL_SERVICE, WIX_USERS, OTHER
        - name: description | type: string | description: Consent description. 
        - name: _updatedDate | type: Date | description: Date and time the consent was updated. 
        - name: optInLevel | type: OptInLevel | description: Consent opt in level, either single or double confirmation. 
             - enum: UNKNOWN_OPT_IN_LEVEL, SINGLE_CONFIRMATION, DOUBLE_CONFIRMATION
     - name: lastRevokeActivity | type: LastRevokeActivity | description: Last revoke activity of the marketing consent. 
        - name: source | type: Source | description: Source of the given revoke (how the visitor signed up). 
             - enum: IN_PERSON, FORM, REVOKE_LINK, WIX_USERS, OTHER
        - name: description | type: string | description: Details about the revoke, if relevant. 
        - name: _updatedDate | type: Date | description: Date and time the consent was updated. 
     - name: extendedFields | type: ExtendedFields | description: Additional 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: pagingMetadata | type: CursorPagingMetadata | description: Details on the paged set of results returned. 
     - 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

### queryMarketingConsent
```javascript
import { marketingConsent } from '@wix/marketing';

async function queryMarketingConsent(query) {
  const response = await marketingConsent.queryMarketingConsent(query);
};
```

### queryMarketingConsent (with elevated permissions)
```javascript
import { marketingConsent } from '@wix/marketing';
import { auth } from '@wix/essentials';

async function myQueryMarketingConsentMethod(query) {
  const elevatedQueryMarketingConsent = auth.elevate(marketingConsent.queryMarketingConsent);
  const response = await elevatedQueryMarketingConsent(query);
}
```

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

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


async function queryMarketingConsent(query) {
  const response = await myWixClient.marketingConsent.queryMarketingConsent(query);
};
```

---