# Deal programs: create, get, list

URL: /code/mcp/deal/records · Id: `page:code/mcp/deal/records`

> The Deal Verbs create, get, list as MCP do programs, with inputs, result, refusals and an example.

Reference for [Deal](/business/nouns/deal), one group of [Deal programs](/code/mcp/deal).

### Deal.create
Creates a Deal. [Verb page](/business/nouns/deal/create?interface=mcp).

```text
do: return await $.Deal.create(input)
```

Emits `Deal.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `value` | `money` | No | What the Deal is worth if won. |
| `owner` | [Worker](/business/nouns/worker) | No | The Worker who runs it. |
| `closesOn` | `date` | No | The date the buyer expects to decide. |
| `nextStep` | `text` | No | The next dated step agreed with the buyer. |
| `organization` | [Organization](/business/nouns/organization) | No | Each Deal has one buying Organization on the other side. |
| `referral` | [Referral](/business/nouns/referral) | No | The Deals a Referral opened; when one is won, its revenue earns the Partner’s Commission. |

**Returns**

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

**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**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Deal.create({ value: { amount: 29, currency: 'USD' } })"
  }
}
```

### Deal.get
Returns one Deal by id. [Verb page](/business/nouns/deal/get?interface=mcp).

```text
do: return await $.Deal.get(input)
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Deal.get({ id: 'deal_NgACZ6DcII' })"
  }
}
```

### Deal.list
Returns Deals, newest first, one page at a time. [Verb page](/business/nouns/deal/list?interface=mcp).

```text
do: return await $.Deal.list(input)
```

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 |
| --- | --- | --- | --- |
| `deals` | list of [Deal](/business/nouns/deal) | Yes | One page of Deals. |

**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**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Deal.list({ limit: 20 })"
  }
}
```