# Campaign methods: create, get, list

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

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

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

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

```ts
interface CampaignVerbs {
  create(input?: CampaignCreateInput, options?: SB.CallOptions): SB.Call<Campaign>
}
```

Emits `Campaign.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `budget` | `money` | No | What it may spend. |
| `startsAt` | `datetime` | No | When it starts. |
| `endsAt` | `datetime` | No | When it ends. |
| `goal` | [Goal](/business/nouns/goal) | No | A Campaign spends its budget and window toward one Goal. |

**Returns**

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

**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 campaign = await $.Campaign.create({ budget: { amount: 29, currency: 'USD' } })
```

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

```ts
interface CampaignVerbs {
  get(input: CampaignGetInput, options?: SB.CallOptions): SB.Call<Campaign>
}
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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 campaign = await $.Campaign.get({ id: 'campaign_NYwCp4DcII' })
```

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

```ts
interface CampaignVerbs {
  list(input?: CampaignListInput, options?: SB.CallOptions): SB.ListCall<Campaign>
}
```

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 |
| --- | --- | --- | --- |
| `campaigns` | list of [Campaign](/business/nouns/campaign) | Yes | One page of Campaigns. |

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