> For the complete documentation index, see [llms.txt](https://docs.edgetag.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgetag.io/implementation/headless/consent/get-consent.md).

# Get Consent

This API allows you to retrieve the consent value provided through the consent function.

### Parameters

| Name     | Type                                 | Required       | Description |                                                                                  |     |                                                                                                                                                                                               |
| -------- | ------------------------------------ | -------------- | ----------- | -------------------------------------------------------------------------------- | --- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| callback | <p>(consent: Record\<string, boolean | Record\<string | boolean>>   | null, error?: Error,<br>consentCategories: Record\<string, boolean>) => void</p> | Yes | Callback function that gives you the consent value of the user. If consent is set to null in the callback which indicates that something went wrong, and access error param for more details. |
| options  | { destination?: string }             | No             |             |                                                                                  |     |                                                                                                                                                                                               |
|          |                                      |                |             |                                                                                  |     |                                                                                                                                                                                               |

#### Options

**Destination**: We recommend specifying the destination, especially if multiple EdgeTag instances exist on the website. If you do not, we will trigger the same event to multiple destinations. The destination value should be the EdgeTag URL.

### Examples

{% code title="When consent exists" %}

```javascript
import { getConsent } from '@blotoutio/edgetag-sdk-js'

getConsent((consent, error, consentCategories) => {
  console.log(consent) // { all: false, facebook: { facebook1: true, facebook2: false }}
  console.log(error) // undefined
  console.log(consentCategories) // { all: false, marketing: true}
})
```

{% endcode %}

{% code title="No consent set yet" %}

```javascript
import { getConsent } from '@blotoutio/edgetag-sdk-js'

getConsent((consent, error, consentCategories) => {
  console.log(consent) // null
  console.log(error) // "Error: Consent Not Found for current user"
  console.log(consentCategories) // null
})
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.edgetag.io/implementation/headless/consent/get-consent.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
