# Contact commands: create, get, list

URL: /code/cli/contact/records · Id: `page:code/cli/contact/records`

> The Contact Verbs create, get, list as CLI commands, with inputs, result, refusals and an example.

Reference for [Contact](/business/nouns/contact), one group of [Contact commands](/code/cli/contact).

### Contact.create
Creates a Contact. [Verb page](/business/nouns/contact/create?interface=cli).

```text
npx startup-builder do Contact.create --json '<input>' [--try | --send | --do]
```

Emits `Contact.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | `email` | No | The primary email address. |
| `phone` | `string` | No | The primary phone number. |
| `name` | `string` | No | The name the Contact goes by. |
| `organization` | [Organization](/business/nouns/organization) | No | A Contact works for one Organization, as this Startup knows it. |
| `person` | [Person](/business/nouns/person) | No | Each Contact is one Startup’s view of a Person shared across every Startup that knows them. |

**Returns**

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

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

```bash
npx startup-builder do Contact.create --json '{"email":"dana@leaseline.app"}'
```

### Contact.get
Returns one Contact by id. [Verb page](/business/nouns/contact/get?interface=cli).

```text
npx startup-builder do Contact.get --json '<input>' [--try]
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

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

```bash
npx startup-builder do Contact.get --json '{"id":"contact_WsrosCQi6J"}'
```

### Contact.list
Returns Contacts, newest first, one page at a time. [Verb page](/business/nouns/contact/list?interface=cli).

```text
npx startup-builder do Contact.list --json '<input>' [--try]
```

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 |
| --- | --- | --- | --- |
| `contacts` | list of [Contact](/business/nouns/contact) | Yes | One page of Contacts. |

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

```bash
npx startup-builder do Contact.list --json '{"limit":20}'
```