# Variant methods: create, get, list

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

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

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

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

```ts
interface VariantVerbs {
  create(input: VariantCreateInput, options?: SB.CallOptions): SB.Call<Variant>
}
```

Emits `Variant.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | `string` | Yes | The name the Flag returns for it. |
| `value` | `json` | Yes | What it changes: copy, behavior, a definition Version, or a Thing. |
| `control` | `boolean` | No | True for the current definition every challenger is judged against. |
| `follows` | [Variant](/business/nouns/variant) | No | The Variant it was drafted from by a learn step. |
| `experiment` | [Experiment](/business/nouns/experiment) | No | The Variants the Experiment can assign, the control among them. |

**Returns**

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

**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 variant = await $.Variant.create({ key: 'Example key', value: {} })
```

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

```ts
interface VariantVerbs {
  get(input: VariantGetInput, options?: SB.CallOptions): SB.Call<Variant>
}
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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 variant = await $.Variant.get({ id: 'variant_nvdfmt7dTw' })
```

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

```ts
interface VariantVerbs {
  list(input?: VariantListInput, options?: SB.CallOptions): SB.ListCall<Variant>
}
```

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 |
| --- | --- | --- | --- |
| `variants` | list of [Variant](/business/nouns/variant) | Yes | One page of Variants. |

**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 variants = await $.Variant.list({ limit: 20 })
```