# Watch methods: create, get, list

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

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

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

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

```ts
interface WatchVerbs {
  create(input: WatchCreateInput, options?: SB.CallOptions): SB.Call<WatchCreateOutput>
}
```

Emits `Watch.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `selector` | `string` | Yes | The Event selector, such as `Order.placed`. |
| `url` | `url` | Yes | Where deliveries go. |
| `payload` | `string` | No | One of `full`, or `thin`: the record as the Action left it, or only its versioned address. The default is full. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `watch` | [Watch](/business/nouns/watch) | Yes | The Watch. |
| `secret` | `string` | Yes | The signing secret, as `whsec_` and 32 characters, shown once: store it beside the receiver. |

**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 { watch, secret } = await $.Watch.create({ selector: 'Example selector', url: 'https://leaseline.app' })
```

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

```ts
interface WatchVerbs {
  get(input: WatchGetInput, options?: SB.CallOptions): SB.Call<Watch>
}
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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 watch = await $.Watch.get({ id: 'watch_9o4vCuR17L' })
```

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

```ts
interface WatchVerbs {
  list(input?: WatchListInput, options?: SB.CallOptions): SB.ListCall<Watch>
}
```

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 |
| --- | --- | --- | --- |
| `watches` | list of [Watch](/business/nouns/watch) | Yes | One page of Watches. |

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