# Consent methods: create, get, list

URL: /code/sdk/consent/records · Id: `page:code/sdk/consent/records`

> The Consent Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.

Reference for [Consent](/business/nouns/consent), one group of [Consent methods](/code/sdk/consent).

### Consent.create
Creates a Consent. [Verb page](/business/nouns/consent/create?interface=sdk).

```ts
interface ConsentVerbs {
  create(input: ConsentCreateInput, options?: SB.CallOptions): SB.Call<Consent>
}
```

Emits `Consent.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `basis` | `string` | Yes | The lawful basis, such as consent or contract. Never randomized. |
| `region` | `string` | No | The jurisdiction whose rules apply. Never randomized. |
| `withdrawnAt` | `datetime` | No | When the person withdrew it. Never randomized. |
| `contact` | [Contact](/business/nouns/contact) | No | A Contact grants Consents, each for one Purpose, with its basis and expiry. |
| `purpose` | [Purpose](/business/nouns/purpose) | No | The Purpose the Consent permits processing for, and nothing beyond it. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `consent` | [Consent](/business/nouns/consent) | Yes | The Consent. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```ts
import { $ } from 'startup-builder'

const consent = await $.Consent.create({ basis: 'Example basis' })
```

### Consent.get
Returns one Consent by id. [Verb page](/business/nouns/consent/get?interface=sdk).

```ts
interface ConsentVerbs {
  get(input: ConsentGetInput, options?: SB.CallOptions): SB.Call<Consent>
}
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Consent. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `consent` | [Consent](/business/nouns/consent) | Yes | The Consent. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```ts
import { $ } from 'startup-builder'

const consent = await $.Consent.get({ id: 'consent_lMkrg7nUGY' })
```

### Consent.list
Returns Consents, newest first, one page at a time. [Verb page](/business/nouns/consent/list?interface=sdk).

```ts
interface ConsentVerbs {
  list(input?: ConsentListInput, options?: SB.CallOptions): SB.ListCall<Consent>
}
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `consents` | list of [Consent](/business/nouns/consent) | Yes | One page of Consents. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```ts
import { $ } from 'startup-builder'

const consents = await $.Consent.list({ limit: 20 })
```