# Mailbox routes: create, get, list

URL: /code/api/mailbox/records · Id: `page:code/api/mailbox/records`

> The Mailbox Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for [Mailbox](/business/nouns/mailbox), one group of [Mailbox routes](/code/api/mailbox).

### Mailbox.create
Creates a Mailbox. [Verb page](/business/nouns/mailbox/create?interface=api).

```text
POST /{namespace}/mailboxes
```

Body, as JSON: the inputs. Emits `Mailbox.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `medium` | `string` | Yes | The platform type, such as `email`, `sms`, or `chat`. |
| `organization` | [Organization](/business/nouns/organization) | No | The outside Organization the Channel is shared with; its new Messages open Conversations for that Customer. |
| `external` | `boolean` | No | True when people from another Organization post in it, as in a channel two companies share. |
| `areaCode` | `string` | No | For an `sms` Channel, the phone area code its number is drawn from, such as `512`. |
| `number` | `string` | No | For an `sms` Channel, its phone number in international form, assigned when it is created. |
| `address` | `email` | Yes | The email address. |
| `stream` | `string` | Yes | What it sends: receipts and resets, broadcasts, or cold outbound; one stream per Mailbox. |
| `tenant` | [Tenant](/business/nouns/tenant) | No | The Tenant it sends for, at a Domain that Tenant’s Customer holds; replies land in the Tenant’s Threads. |

**Returns**

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

**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
curl -X POST https://api.sb/leaseline.app/mailboxes \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"medium":"email","address":"dana@leaseline.app","stream":"transactional"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "mailbox": {
    "$id": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L",
    "$type": "Mailbox",
    "medium": "email",
    "address": "dana@leaseline.app",
    "stream": "transactional"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Mailbox.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Mailbox.get
Returns one Mailbox by id. [Verb page](/business/nouns/mailbox/get?interface=api).

```text
GET /{namespace}/mailboxes/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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
curl https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Mailbox",
  "$id": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L",
  "mailbox": {
    "$id": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L",
    "$type": "Mailbox",
    "medium": "email",
    "address": "dana@leaseline.app",
    "stream": "transactional"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L",
    "up": "https://api.sb/leaseline.app/mailboxes"
  },
  "actions": {
    "rest": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L/rest",
    "retire": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L/retire",
    "warm": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L/warm"
  }
}
```

### Mailbox.list
Returns Mailboxes, newest first, one page at a time. [Verb page](/business/nouns/mailbox/list?interface=api).

```text
GET /{namespace}/mailboxes
```

Query: the inputs. 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 |
| --- | --- | --- | --- |
| `mailboxes` | list of [Mailbox](/business/nouns/mailbox) | Yes | One page of Mailboxes. |

**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
curl "https://api.sb/leaseline.app/mailboxes?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Mailbox",
  "mailboxes": [
    {
      "$id": "https://api.sb/leaseline.app/mailboxes/mailbox_93HvOnR17L",
      "$type": "Mailbox",
      "medium": "email",
      "address": "dana@leaseline.app",
      "stream": "transactional"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "mailbox_93HvOnR17L"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/mailboxes?limit=20",
    "next": "https://api.sb/leaseline.app/mailboxes?after=mailbox_93HvOnR17L"
  }
}
```