# Comment methods: create, get, list

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

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

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

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

```ts
interface CommentVerbs {
  create(input: CommentCreateInput, options?: SB.CallOptions): SB.Call<Comment>
}
```

Emits `Comment.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `body` | `text` | Yes | What it says. |
| `thing` | [Thing](/business/nouns/thing) | No | A Comment is an internal note on one Thing, never sent to a Contact. |
| `worker` | [Worker](/business/nouns/worker) | No | Every Comment names the Worker, human or agent, who wrote it. |

**Returns**

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

**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 comment = await $.Comment.create({ body: 'Example body' })
```

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

```ts
interface CommentVerbs {
  get(input: CommentGetInput, options?: SB.CallOptions): SB.Call<Comment>
}
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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 comment = await $.Comment.get({ id: 'comment_MUIgpgdysq' })
```

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

```ts
interface CommentVerbs {
  list(input?: CommentListInput, options?: SB.CallOptions): SB.ListCall<Comment>
}
```

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 |
| --- | --- | --- | --- |
| `comments` | list of [Comment](/business/nouns/comment) | Yes | One page of Comments. |

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